activerecord-pg_array 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 172e09d68f70267cfa5a3006fed692028654160e
-  data.tar.gz: acc747b399b0329544ca3aa5528fa925ce05709c
+  metadata.gz: 5469d83f3321a3a99f615391b6561474db1cf71f
+  data.tar.gz: 866d1ca55c92eec1b9200d875f58d33adb4c272d
 SHA512:
-  metadata.gz: 259b080e1115a99c55869a1426b425b1c860817255a4fd075f82812731e3d4064880d2a8a6b3ecab38f3fbadacb4b7d716b393896ef55c3f87dd4d7f33081180
-  data.tar.gz: 53051ee448a0aa5c0b288825391390eea2fb359d5d40c95051de82bf24db51abbf58ce6138fe7a89c33177a8032f7e09902dccb0383a8e5e7eeb89b2c0c5dca6
+  metadata.gz: 44adb77c3d1ec61dabec9b7b81354091710182f24d8185fae634b2cd15d467b68b04a71fdcdefa2df557e54611623050e72c1800ac8d8c64aa888f8ec3ec1941
+  data.tar.gz: 44f69af520b86d204595551b70d8a62081f1c1143f596b8531f1ac84cfd6bd518f8369c57b7e1d592480372df82d8387f9ba0dc3e6d3ed4f8968c6b6e82f6155

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+end
+

data/README.md

@@ -1,52 +1,81 @@
-# Activerecord::PgArray
+# ActiveRecord::PGArray
 
-This gem defines methods in your models for ActiveRecord attributes that use Postgres's arrays.
+This gem defines methods in your models for ActiveRecord attributes that use Postgresql's arrays.
 
-I wrote this gem because I realized that working with Postgresql arrays was not as straight-forward as I had hoped.
+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'
+```ruby
+gem 'activerecord-pg_array'
+```
 
 ## Usage
 
 Then in your classes that inherit from ActiveRecord `include ActiveRecord::PGArray`
 
-### Example:
+### Silly 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
+```ruby
+class CreateWoldTracker < ActiveRecord::Migration
+  def change
+    create_table :wolf_trackers do |t|
+      t.string :name
+      t.integer :wolf_ids, array: true, default: []
+      t.string :pack_names, array: true, default: []
     end
 
+    add_index :wolf_trackers, :wolf_ids, using: 'gin'
+  end
+end
+```
+
 And class:
 
-    class MyClass < ActiveRecord::Base
-      include ActiveRecord::PGArray
-    end
+```ruby
+class WolfTracker < 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)
+```ruby
+add_wolf(wolfy)            # ActiveRecord object wolfy's id is appended to wolf_ids
+add_wolf!(son_of_wolfy)    # wolf_ids appended with atomic update
+add_wolves([wolfia, 4])    # add multiple to wolf_ids. Note: irregular plural method name and mixed input
+remove_wolf(wolfia)        # wolf_ids is modified but not saved
+remove_wolf!(3)            # wolf_ids atomic removal
+wolves                     # looks up wolf objects with ids wolf_ids
+```
+
+The same is true for pack_names:
+
+```ruby
+add_pack_name('Stark')
+add_pack_name!('Karstark')
+add_pack_names(['Greyjoy', 'Bolton'])
+remove_pack_name('Greyjoy')
+remove_pack_name!('Bolton')
+# does not define a finder method based on pack_names
+```
+
+## Dynamically created method rules
+
+* If an ActiveRecord attribute ends with "_ids", that suffix will be removed from the method name.
+* If the attribute is an array of integers ending with "_ids", then if an ActiveRecord object is passed to it, the id of that object will used.
+* Method names will use the singular or plural form of the attribute name when defining the method.
 
 ## 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
+* Finish writing all specs
+* Actual atomic operations :)
+* Perhaps add some handy query interface stuff or at least document how query arrays with ActiveRecord.
+* rdoc documentation
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/activerecord-pg_array.gemspec

@@ -19,7 +19,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activerecord'
+  spec.add_dependency "activerecord", "~> 3.0"
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "pg", "~> 0.17"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "guard", "~> 2.4"
+  spec.add_development_dependency "guard-rspec", "~> 4.2"
 end

data/lib/activerecord/pg_array/version.rb

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

data/lib/activerecord/pg_array.rb

@@ -5,9 +5,9 @@ module ActiveRecord
 
     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|
+        self.column_types.to_a.select { |c| c[1].instance_variable_get('@array') }.map(&:first).each do |attr_name|
           ids_regex = /_ids$/
-          friendly_attr = array_column_name.sub(ids_regex,'')
+          friendly_attr = attr_name.sub(ids_regex,'')
           segs = friendly_attr.split('_')
           segs[-1] = segs[-1].singularize
           friendly_attr_singular = segs.join('_')
@@ -15,16 +15,17 @@ module ActiveRecord
           friendly_attr_plural = segs.join('_')
 
           obj_convert = ->(obj) do
-            if array_column_name =~ ids_regex && obj.kind_of?(ActiveRecord::Base)
+            if attr_name =~ ids_regex && obj.kind_of?(ActiveRecord::Base) and
+               self.column_types[attr_name].type == :integer
               obj = obj.id
             end
             obj
           end
           atr = ->(slf) do
-            slf.send array_column_name.to_sym
+            slf.send attr_name.to_sym
           end
           atr_will_change = ->(slf) do
-            slf.send(:"#{array_column_name}_will_change!")
+            slf.send(:"#{attr_name}_will_change!")
           end
 
           define_method :"add_#{friendly_attr_singular}" do |obj|
@@ -36,8 +37,15 @@ module ActiveRecord
           end
 
           define_method :"add_#{friendly_attr_singular}!" do |obj|
-            self.send :"add_#{friendly_attr_singular}", obj
-            self.save!
+            obj = obj_convert[obj]
+            atr_will_change[self] # seems strange that calling this is needed
+            
+            # There are two external issues that block atomic updates to one attribute.
+            # 1. ActiveRecord update_attribute actually updates all attributes that are dirty! This surprised me.
+            # 2. update_column doesn't work on pg arrays for rails < 4.0.4 (which is not yet released)
+            #    https://github.com/rails/rails/issues/12261
+            atr[self].push(obj).uniq!
+            self.update_attribute attr_name.to_sym, atr[self]
           end
 
           define_method :"add_#{friendly_attr_plural}" do |objs|
@@ -49,7 +57,7 @@ module ActiveRecord
           define_method :"remove_#{friendly_attr_singular}" do |obj|
             obj = obj_convert.call(obj)
             if atr[self].include?(obj)
-              atr[self].remove(obj)
+              atr[self].delete(obj)
               atr_will_change[self]
             end
           end
@@ -59,6 +67,26 @@ module ActiveRecord
             self.save!
           end
 
+          
+          # define basic relational lookup methods
+          # example:
+          #   Given wolf_ids is the attribute
+          #   Then it will try to define method wolves that retrieves wolf objects
+          if attr_name =~ ids_regex
+            if defined?(friendly_attr_singular.camelize.to_sym) and
+               self.column_types[attr_name].type == :integer
+              begin
+                klass = friendly_attr_singular.camelize.constantize
+
+                # it might be better to define a scope instead
+                define_method friendly_attr_plural.to_sym do
+                  klass.where(id: [atr[self]])
+                end
+              rescue NameError
+              end
+            end
+          end
+
         end
       end # base.class_eval
     end # self.include

data/spec/lib/pg_array_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'active_record'
+
+class Wolf < ActiveRecord::Base
+end
+class Chicken < ActiveRecord::Base
+end
+
+require 'support/active_record'
+require 'pry'
+
+class WolfTracker < ActiveRecord::Base
+  include ActiveRecord::PGArray
+end
+
+describe WolfTracker do
+  let(:wolf_tracker)  { WolfTracker.create(name: 'Wolfram') }
+  let(:wolfy) { Wolf.create(name: 'Wolfy') }
+  let(:son_of_wolfy) { Wolf.create(name: 'Son of Wolfy') }
+  let(:wolfia) { Wolf.create(name: 'Wolfia') }
+
+  context 'base state' do
+    it "should have empty wolf_ids" do
+      expect(wolf_tracker.wolf_ids).to be_empty
+    end
+
+    it "should have empty pack_names" do
+      expect(wolf_tracker.pack_names).to be_empty
+    end
+  end
+
+  context 'method names' do
+    subject { WolfTracker.new }
+
+    it { should respond_to(:add_wolf) }
+    it { should respond_to(:add_wolf!) }
+    it { should respond_to(:add_wolves) }
+    it { should respond_to(:remove_wolf) }
+    it { should respond_to(:remove_wolf!) }
+
+    it { should respond_to(:add_pack_name) }
+    it { should respond_to(:add_pack_name!) }
+    it { should respond_to(:add_pack_names) }
+    it { should respond_to(:remove_pack_name) }
+    it { should respond_to(:remove_pack_name!) }
+  end
+
+  context 'persistence' do
+
+    context "add_<attr_name>" do
+      it "should add_<attr>" do
+        wolf_tracker.add_wolf(wolfy)
+        wolf_tracker.save!
+        wolf_tracker.reload
+        expect(wolf_tracker.wolf_ids).to eq [wolfy.id]
+      end
+
+      it "should add_<attr>! " do
+        wolf_tracker.add_wolf!(wolfy)
+        wolf_tracker.reload
+        expect(wolf_tracker.wolf_ids).to eq [wolfy.id]
+      end
+
+      it "should not update other changed attributes if atomic" do
+        wolf_tracker.name = 'Big Bad Wolf'
+        wolf_tracker.add_wolf!(wolfy)
+        pending "see note where add_<attr_name>! is defined. blocked by external issues"
+        wolf_tracker.reload
+        expect(wolf_tracker.name).to eq 'Wolfram'
+      end
+
+      it "should add with regular integer value" do
+        wolf_tracker.add_wolf(1)
+        wolf_tracker.save!
+        wolf_tracker.reload
+        expect(wolf_tracker.wolf_ids).to eq [1]
+      end
+
+      it "should add with regular string value" do
+        wolf_tracker.add_pack_name('of one')
+        wolf_tracker.save!
+        expect(wolf_tracker.reload.pack_names).to eq ['of one']
+      end
+
+    end # with ActiveRecord object
+
+    context "remove" do
+      before do
+        wolf_tracker.add_wolf!(wolfy)
+        wolf_tracker.reload
+        expect(wolf_tracker.wolf_ids).to eq [wolfy.id]
+      end
+
+      it "should remove_<attr>" do
+        wolf_tracker.remove_wolf(wolfy)
+        wolf_tracker.save!
+        expect(wolf_tracker.reload.wolf_ids).to be_empty
+      end
+
+      it "should remove_<attr>!" do
+        wolf_tracker.remove_wolf!(wolfy.id)
+        expect(wolf_tracker.reload.wolf_ids).to be_empty
+      end
+    end # remove
+
+    it 'should have more specs' do
+      pending 'you\'re not done writing specs'
+    end
+
+  end # persistence
+
+  describe "finder methods" do
+    before do
+      wolf_tracker.add_wolves([wolfy, son_of_wolfy]) 
+      wolf_tracker.save!
+    end
+
+    it { should respond_to(:wolves) }
+    it { should_not respond_to(:chickens) }
+
+    it "should have a wolves finder method and return a wolf" do
+      expect(wolf_tracker.wolves).to eq [wolfy, son_of_wolfy]
+    end
+
+  end # scopes
+end

data/spec/schema.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20140227091226) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "wolf_trackers", force: true do |t|
+    t.string  "name"
+    t.integer "wolf_ids",   default: [], array: true
+    t.string  "pack_names", default: [], array: true
+    t.string  "chicken_ids",  default: [], array: true # this is intentionally an array of strings
+  end
+
+  add_index "wolf_trackers", ["wolf_ids"], name: "index_wolf_trackers_on_wolf_ids", using: :gin
+
+  create_table "wolves", force: true do |t|
+    t.string "name"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'activerecord/pg_array'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/active_record.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+
+# create a postgresql database:
+#   createdb pg_array_test
+ActiveRecord::Base.establish_connection adapter: :postgresql, database: 'pg_array_test', username: ENV['PG_DB_USERNAME'], password: ENV['PG_DB_PASSWORD']
+
+load 'schema.rb'
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg_array
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean McCleary
@@ -14,16 +14,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,86 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 description: A ruby gem that makes working with Postgres arrays in ActiveRecord easier
 email:
 - seanmcc@gmail.com
@@ -60,13 +130,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - activerecord-pg_array.gemspec
 - lib/activerecord/pg_array.rb
 - lib/activerecord/pg_array/version.rb
+- spec/lib/pg_array_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
 homepage: https://github.com/mrinterweb/activerecord-pg_array
 licenses:
 - MIT
@@ -87,10 +163,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: This gem defines methods in your models for ActiveRecord attributes that
   use Postgres's arrays
-test_files: []
+test_files:
+- spec/lib/pg_array_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
 has_rdoc: