atomic_arrays 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f109dc67250882c4425341e1c12ae2abd8d9b80
+  data.tar.gz: fce753b3c188ca2a2ae971e68af482e2bce202b3
+SHA512:
+  metadata.gz: 8e3d5194b39f156b5035e671846f1714a1a4ad85b4b3ee921ebddb2c030aae715381dd24b0bb61aff0858dc09ab38fe04feaf669dc7f23d67a26fc25cd841c97
+  data.tar.gz: 57fdedc6dbf69f9145c522b9c237ea328c84b845fc83efe87592c6f4e28264497986fd3450c5d4c7507acdddda83f26ac5993471128e65c5ca696a5b8a691283

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joey
+
+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,29 @@
+# AtomicArrays
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'atomic_arrays'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install atomic_arrays
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/atomic_arrays/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,38 @@
+require "bundler/gem_tasks"
+require "rubygems"
+require "bundler/setup"
+
+require "pg"
+require "active_record"
+require "yaml"
+require 'rspec/core/rake_task'
+
+namespace :db do
+
+  desc "Migrate the db"
+  task :migrate do
+    connection_details = YAML.load_file(File.expand_path("../spec/db/database.yml", __FILE__))["test"]
+    ActiveRecord::Base.establish_connection(connection_details)
+    ActiveRecord::Migrator.migrate("spec/db/")
+  end
+
+
+  desc "Create the db"
+  task :create do
+    connection_details = YAML.load_file(File.expand_path("../spec/db/database.yml", __FILE__))["test"]
+    ActiveRecord::Base.establish_connection(connection_details.merge({'database' => 'postgres', 'schema_search_path' => 'public'}))
+    ActiveRecord::Base.connection.create_database(connection_details.fetch('database'))
+  end
+
+  desc "drop the db"
+  task :drop do
+    connection_details = YAML.load_file(File.expand_path("../spec/db/database.yml", __FILE__))["test"]
+    ActiveRecord::Base.establish_connection(connection_details.merge({'database' => 'postgres', 'schema_search_path' => 'public'}))
+    ActiveRecord::Base.connection.drop_database(connection_details.fetch('database'))
+  end
+end
+
+RSpec::Core::RakeTask.new(:spec)
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+task default: :spec

data/atomic_arrays.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'atomic_arrays/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "atomic_arrays"
+  spec.version       = AtomicArrays::VERSION
+  spec.authors       = ["Joseph"]
+  spec.email         = ["joseph.cs.ritchie@gmail.com"]
+  spec.summary       = %q{ActiveRecord extension for atomically updating PostgreSQL arrays.}
+  spec.description   = %q{AtomicArrays aims to assist ActiveRecord with updating Postgres arrays
+                          by offering a couple simple methods to change arrays in both the database
+                          and the instance it is called on. These methods are atomic in nature
+                          because they update the arrays in the database without relying on the current
+                          object's instantiated arrays.}
+  spec.homepage      = "https://github.com/twincharged/atomic_arrays"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", ">= 10.3.2"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "pg", ">= 0.17.1"
+
+  spec.add_runtime_dependency "activerecord", ">= 4.0"
+end

data/lib/atomic_arrays/version.rb

@@ -0,0 +1,3 @@
+module AtomicArrays
+  VERSION = "1.0.0"
+end

data/lib/atomic_arrays.rb

@@ -0,0 +1,63 @@
+require "atomic_arrays/version"
+
+module AtomicArrays
+
+  def self.included(klass)
+      klass.class_eval do
+        extend AtomicClassMethods
+      end
+  end
+
+  def atomic_append(field, value)
+      raise "Cannot append multiple values." if value.is_a?(Array)
+      value = prepare_array_vals(value)
+      return self.execute_array_query(field, value, "array_append")
+  end
+
+  def atomic_remove(field, value)
+      raise "Cannot remove multiple values." if value.is_a?(Array)
+      value = prepare_array_vals(value)
+      return self.execute_array_query(field, value, "array_remove")
+  end
+
+  def atomic_cat(field, values)
+      raise "Cannot cat strings or integers" if (values.is_a?(Integer) || values.is_a?(String))
+      values = prepare_array_vals(values)
+      return self.execute_array_query(field, "ARRAY[#{values}]", "array_cat")
+  end
+
+  def atomic_relate(field, related_class, limit=100)
+      raise "Relates to a class, not a string or integer." if (related_class.is_a?(Integer) || related_class.is_a?(String))
+      (table, field) = self.prepare_array_query(field)
+      related_table = related_class.table_name.inspect
+      return result = related_class.execute_and_wrap(%Q{SELECT #{related_table}.* FROM #{related_table} WHERE #{related_table}.id IN (SELECT unnest(#{table}.#{field}) FROM #{table} WHERE #{table}.id = #{self.id}) LIMIT #{limit}})
+  end
+
+  def execute_array_query(field, value, array_method)
+      (table, field) = self.prepare_array_query(field)
+      result = self.class.execute_and_wrap(%Q{UPDATE #{table} SET #{field} = #{array_method}(#{field}, #{value}) WHERE #{table}.id = #{self.id} RETURNING #{table}.*})
+      return result[0]
+  end
+
+  def prepare_array_query(field)
+      table = self.class.table_name.inspect
+      field = field.to_s.inspect
+      return [table, field]
+  end
+
+  def prepare_array_vals(value)
+      prep_array = []
+      [*value].map {|val| val = "\'#{val}\'" if val.class == String; prep_array.push(val)} 
+      return prep_array.join(", ")
+  end
+
+  module AtomicClassMethods
+    def execute_and_wrap(sql, binds=[])
+      result_set = self.connection.select_all(self.sanitize_sql(sql), "#{self.name} Load", binds)
+      column_types = {}
+      column_types = result_set.column_types if result_set.respond_to?(:column_types)
+      return result_set.map { |record| self.instantiate(record, column_types) }
+    end
+  end
+
+end

data/spec/atomic_arrays_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe AtomicArrays do
+
+  before(:all) do
+    @user1 = User.find(1)
+    @user2 = User.find(2)
+    @user3 = User.find(3)
+    @user4 = User.find(4)
+    @user5 = User.find(5)
+    @user6 = User.find(6)
+    @comment1 = Comment.find(1)
+    @comment2 = Comment.find(2)
+    @comment3 = Comment.find(3)
+    @comment4 = Comment.find(4)
+    @comment5 = Comment.find(5)
+    @comment6 = Comment.find(6)
+  end
+
+  describe "atomic appending" do
+
+    it "should append string to user" do
+      hob = "NewHobby"
+      user = @user1.atomic_append(:hobbies, hob)
+      expect(user.hobbies).to include hob
+      expect(User.find(1).hobbies).to include hob
+    end
+
+    it "should append string to comment" do
+      tag = "NewTag"
+      comm = @comment1.atomic_append(:tags, tag)
+      expect(comm.tags).to include tag
+      expect(Comment.find(1).tags).to include tag
+    end
+
+    it "should append integer to user" do
+      id = 9
+      user = @user2.atomic_append(:comment_ids, id)
+      expect(user.comment_ids).to include id
+      expect(User.find(2).comment_ids).to include id
+    end
+
+    it "should append string to comment" do
+      id = 8
+      comm = @comment2.atomic_append(:liker_ids, id)
+      expect(comm.liker_ids).to include id
+      expect(Comment.find(2).liker_ids).to include id
+    end
+  end
+
+
+  describe "atomic removing" do
+
+    it "should remove string to user" do
+      hob = "NewHobby"
+      user = @user1.atomic_remove(:hobbies, hob)
+      expect(user.hobbies).to_not include hob
+      expect(User.find(1).hobbies).to_not include hob
+    end
+
+    it "should remove string to comment" do
+      tag = "NewTag"
+      comm = @comment1.atomic_remove(:tags, tag)
+      expect(comm.tags).to_not include tag
+      expect(Comment.find(1).tags).to_not include tag
+    end
+
+    it "should remove integer to user" do
+      id = 9
+      user = @user2.atomic_remove(:comment_ids, id)
+      expect(user.comment_ids).to_not include id
+      expect(User.find(2).comment_ids).to_not include id
+    end
+
+    it "should remove string to comment" do
+      id = 8
+      comm = @comment2.atomic_remove(:liker_ids, id)
+      expect(comm.liker_ids).to_not include id
+      expect(Comment.find(2).liker_ids).to_not include id
+    end
+  end
+
+
+
+  describe "atomic concatenating" do
+
+    it "should cat strings to user" do
+      hobs = ["NewHobby", "Anothernewhobby", "Hobby3"]
+      user = @user3.atomic_cat(:hobbies, hobs)
+      expect(user.hobbies).to include *hobs
+      expect(User.find(3).hobbies).to include *hobs
+    end
+
+    it "should cat strings to comment" do
+      tags = ["NewTag", "#sick", "#iheartfood"]
+      comm = @comment3.atomic_cat(:tags, tags)
+      expect(comm.tags).to include *tags
+      expect(Comment.find(3).tags).to include *tags
+    end
+
+    it "should cat integers to user" do
+      ids = [9,234,12,7]
+      user = @user3.atomic_cat(:comment_ids, ids)
+      expect(user.comment_ids).to include *ids
+      expect(User.find(3).comment_ids).to include *ids
+    end
+
+    it "should cat strings to comment" do
+      ids = [8,98,43,22]
+      comm = @comment3.atomic_cat(:liker_ids, ids)
+      expect(comm.liker_ids).to include *ids
+      expect(Comment.find(3).liker_ids).to include *ids
+    end
+  end
+
+
+
+  describe "atomic relating" do
+
+    it "should relate comment id array" do
+      comm = [@comment1,@comment2,@comment4]
+      @user3.update({comment_ids: comm.map(&:id)})
+      comments = @user3.atomic_relate(:comment_ids, Comment)
+      expect(comments).to include *comm
+    end
+
+    it "should relate user id array" do
+      us = [@user1,@user2,@user4]
+      @comment5.update({liker_ids: us.map(&:id)})
+      users = @comment5.atomic_relate(:liker_ids, User)
+      expect(users).to include *us
+    end
+  end
+
+end

data/spec/db/001_create_users.rb

@@ -0,0 +1,12 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users, force: true do |t|
+      t.string  :name
+      t.integer :age
+      t.text    :hobbies, array: true, default: []
+      t.integer :comment_ids, array: true, default: []
+
+      t.timestamps
+    end
+  end
+end

data/spec/db/002_create_comments.rb

@@ -0,0 +1,12 @@
+class CreateComments < ActiveRecord::Migration
+  def change
+    create_table :comments, force: true do |t|
+      t.integer :user_id
+      t.text    :body
+      t.text    :tags, array: true, default: []
+      t.integer :liker_ids, array: true, default: []
+
+      t.timestamps
+    end
+  end
+end

data/spec/db/database.yml

@@ -0,0 +1,6 @@
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: atomictest
+  pool: 5
+  host: localhost

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require "atomic_arrays"
+require "active_record"
+require "rspec"
+require "yaml"
+
+ActiveRecord::Base.establish_connection(YAML.load_file(File.expand_path("../db/database.yml", __FILE__))["test"])
+# load File.dirname(__FILE__) + '/migrations.rb'
+
+
+class User < ActiveRecord::Base
+  include AtomicArrays
+end
+
+
+class Comment < ActiveRecord::Base
+  include AtomicArrays
+end
+
+Comment.create({id: 1, user_id: 1, body: "from user 1!!!", tags: ["#fun"]})
+Comment.create({id: 2, user_id: 2, body: "from user 2!!!", liker_ids: [4,5]})
+Comment.create({id: 3, user_id: 3, body: "from user 2!!!", tags: ["#fun", "#coolpostbro"]})
+Comment.create({id: 4, user_id: 3, body: "from user 3!!!", liker_ids: [2,3]})
+Comment.create({id: 5, user_id: 5, body: "from user 4!!!", tags: ["#yay"], liker_ids: [1,2]})
+Comment.create({id: 6, user_id: 5, body: "from user 5!!!", liker_ids: [1]})
+
+User.create({id: 1, name: "John", age: 34, hobbies: ["skateboarding"], comment_ids: [1]})
+User.create({id: 2, name: "James", age: 25, hobbies: ["eating", "basketball"], comment_ids: [2]})
+User.create({id: 3, name: "Jane", age: 27, hobbies: ["hanging out"], comment_ids: [3, 4]})
+User.create({id: 4, name: "Bill", age: 22, hobbies: ["Studying", "Online chatting"]})
+User.create({id: 5, name: "Natasha", age: 41, hobbies: ["Nothing"], comment_ids: [5, 6]})
+User.create({id: 6, name: "Courtney", age: 32})

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: atomic_arrays
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joseph
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |-
+  AtomicArrays aims to assist ActiveRecord with updating Postgres arrays
+                            by offering a couple simple methods to change arrays in both the database
+                            and the instance it is called on. These methods are atomic in nature
+                            because they update the arrays in the database without relying on the current
+                            object's instantiated arrays.
+email:
+- joseph.cs.ritchie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- atomic_arrays.gemspec
+- lib/atomic_arrays.rb
+- lib/atomic_arrays/version.rb
+- spec/atomic_arrays_spec.rb
+- spec/db/001_create_users.rb
+- spec/db/002_create_comments.rb
+- spec/db/database.yml
+- spec/spec_helper.rb
+homepage: https://github.com/twincharged/atomic_arrays
+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: ActiveRecord extension for atomically updating PostgreSQL arrays.
+test_files:
+- spec/atomic_arrays_spec.rb
+- spec/db/001_create_users.rb
+- spec/db/002_create_comments.rb
+- spec/db/database.yml
+- spec/spec_helper.rb