active_record-json_associations 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67f879bede0474e8a73e798f7f4facf1370f2d98
+  data.tar.gz: 17f1a8d6d4654a93fb2bdeb373b1a44e3d9bf21c
+SHA512:
+  metadata.gz: 2830b22a574bcc27a058ec51f0a7d39f9429c5211ca42b5373edd3b6cc9e10eaa986b9c0d5279275b0624bcd97c9efc5a75ef8f96e92224ed66f3bea7a137a27
+  data.tar.gz: abf5a10b7af2e76d2d5ff0e2edd3357d3e22adee309291262630fb8801ab0b7a60b7163680cdc20e48a111dc730e8ef5769b7250ca4223ae7c2cf50ab214f95f

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+.ruby-gemset
+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
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.3.3
+  - 2.4.0
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Micah Geisel
+
+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,63 @@
+# ActiveRecord::JsonAssociations
+
+[![Build Status](https://travis-ci.org/botandrose/active_record-json_associations.svg)](https://travis-ci.org/botandrose/active_record-json_associations)
+[![Code Climate](https://codeclimate.com/github/botandrose/active_record-json_associations/badges/gpa.svg)](https://codeclimate.com/github/botandrose/active_record-json_associations)
+
+Instead of keeping the foreign keys on the children, or in a many-to-many join table, let's keep them in a JSON array on the parent.
+
+## Usage
+
+```ruby
+require "active_record/json_associations"
+
+ActiveRecord::Schema.define do
+  create_table :parents do |t|
+    t.text :child_ids
+  end
+
+  create_table :children
+end
+
+class Parent < ActiveRecord::Base
+  belongs_to_many :children
+end
+```
+
+This will add some familiar `has_many`-style methods:
+
+```ruby
+parent.children? #=> false
+
+parent.children = [Child.create!, Child.create!, Child.create!]
+parent.children #=> [#<Child id: 1>, #<Child id: 2>, #<Child id: 3>]
+
+parent.child_ids = [1,2]
+parent.child_ids #=> [1,2]
+
+parent.children? #=> true
+```
+
+It also adds an `json_foreign_key` option to `has_many` for specifying that the foreign keys are in a json array.
+
+```ruby
+class Child
+  has_many :parents, json_foreign_key: true # infers :child_ids, but can be overridden
+end
+
+child = Child.create!
+parent = Parent.create children: [child]
+child.parents == [parent] #=> true
+```
+
+## Requirements
+
+* ActiveRecord 5.0+
+
+## Contributing
+
+1. Fork it ( https://github.com/botandrose/active_record-json_associations/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/active_record-json_associations.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/json_associations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record-json_associations"
+  spec.version       = ActiveRecord::JsonAssociations::VERSION
+  spec.authors       = ["Micah Geisel"]
+  spec.email         = ["micah@botandrose.com"]
+  spec.summary       = %q{Instead of a many-to-many join table, serialize the ids into a JSON array.}
+  spec.description   = %q{Instead of a many-to-many join table, serialize the ids into a JSON array.}
+  spec.homepage      = "https://github.com/botandrose/active_record-json_associations"
+  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_dependency "activerecord"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug"
+end
+

data/lib/active_record/json_associations.rb

@@ -0,0 +1,89 @@
+require "active_record"
+require "json"
+
+module ActiveRecord
+  module JsonAssociations
+    def belongs_to_many(many, class_name: nil)
+      one = many.to_s.singularize
+      one_ids = :"#{one}_ids"
+      one_ids_equals = :"#{one_ids}="
+      class_name ||= one.classify
+      many_equals = :"#{many}="
+      many_eh = :"#{many}?"
+
+      serialize one_ids, JSON
+
+      include Module.new {
+        define_method one_ids do
+          super() || []
+        end
+
+        define_method many do
+          class_name.constantize.where(id: send(one_ids))
+        end
+
+        define_method many_equals do |collection|
+          send one_ids_equals, collection.map(&:id)
+        end
+
+        define_method many_eh do
+          send(one_ids).any?
+        end
+      }
+    end
+
+    def has_many many, scope = nil, options = {}, &extension
+      unless scope.try(:[], :json_foreign_key) || options.try(:[], :json_foreign_key)
+        return super
+      end
+
+      if scope.is_a?(Hash)
+        options = scope
+        scope   = nil
+      end
+
+      one = many.to_s.singularize
+      class_name ||= one.classify
+      klass = class_name.constantize
+
+      one_ids = :"#{one}_ids"
+      one_ids_equals = :"#{one_ids}="
+      many_equals = :"#{many}="
+      many_eh = :"#{many}?"
+
+      foreign_key = options[:json_foreign_key]
+      foreign_key = :"#{model_name.singular}_ids" if foreign_key == true
+
+      include Module.new {
+        define_method one_ids do
+          send(many).pluck(:id)
+        end
+
+        define_method one_ids_equals do |ids|
+          send many_equals, klass.find(ids)
+        end
+
+        define_method many do
+          klass.where("#{foreign_key} LIKE '[#{id}]'").or(
+            klass.where("#{foreign_key} LIKE '[#{id},%'")).or(
+            klass.where("#{foreign_key} LIKE '%,#{id},%'")).or(
+            klass.where("#{foreign_key} LIKE '%,#{id}]'"))
+        end
+
+        define_method many_equals do |collection|
+          collection.each do |record|
+            new_id_array = Array(record.send(foreign_key)) | [id]
+            record.update foreign_key => new_id_array
+          end
+        end
+
+        define_method many_eh do
+          send(many).any?
+        end
+      }
+    end
+  end
+
+  Base.extend JsonAssociations
+end
+

data/lib/active_record/json_associations/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module JsonAssociations
+    VERSION = "0.6.0"
+  end
+end

data/spec/json_associations_spec.rb

@@ -0,0 +1,229 @@
+require "active_record/json_associations"
+
+describe ActiveRecord::JsonAssociations do
+  before do
+    ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+    silence_stream(STDOUT) do
+      ActiveRecord::Schema.define do
+        create_table :parents do |t|
+          t.text :child_ids
+          t.text :fuzzy_ids
+        end
+
+        create_table :children
+
+        create_table :pets
+      end
+    end
+
+    class Parent < ActiveRecord::Base
+      belongs_to_many :children
+      belongs_to_many :fuzzies, class_name: "Pet"
+    end
+
+    class Child < ActiveRecord::Base
+      has_many :parents, json_foreign_key: true
+    end
+
+    class Pet < ActiveRecord::Base
+      has_many :parents, json_foreign_key: :fuzzy_ids
+    end
+  end
+ 
+  describe ".belongs_to_many :children" do
+    subject { Parent.new }
+
+    describe "#child_ids" do
+      it "is empty by default" do
+        expect(subject.child_ids).to eq []
+      end
+
+      it "is an accessor" do
+        subject.child_ids = [1,2,3]
+        expect(subject.child_ids).to eq [1,2,3]
+      end
+    end
+
+    describe "#children" do
+      let(:children) { [Child.create!, Child.create!, Child.create!] }
+
+      it "returns an empty array when there are no children" do
+        expect(subject.children).to eq []
+      end
+
+      it "finds the children by id" do
+        subject.child_ids = [1,2,3]
+        expect(subject.children).to eq children
+      end
+
+      it "is an accessor" do
+        subject.children = children
+        expect(subject.children).to eq children
+      end
+    end
+
+    describe "#children?" do
+      let(:children) { [Child.create!, Child.create!, Child.create!] }
+
+      it "returns false when there are no children" do
+        expect(subject.children?).to be_falsey
+      end
+
+      it "returns true when there are children" do
+        subject.children = children
+        expect(subject.children?).to be_truthy
+      end
+    end
+
+    context "when overriding class name" do
+      let(:pets) { [Pet.create!, Pet.create!, Pet.create!] }
+
+      it "returns an empty array when there are no children" do
+        expect(subject.fuzzies).to eq []
+      end
+
+      it "finds the children by id" do
+        subject.fuzzy_ids = [1,2,3]
+        expect(subject.fuzzies).to eq pets
+      end
+    end
+  end
+
+  describe ".has_many :parents, json_foreign_key: true" do
+    subject { Child.create! }
+
+    let(:parents) { [Parent.create!, Parent.create!, Parent.create!] }
+
+    describe "#parent_ids" do
+      it "is empty by default" do
+        expect(subject.parent_ids).to eq []
+      end
+
+      it "is an accessor" do
+        subject.parent_ids = parents.map(&:id)
+        expect(subject.parent_ids).to eq parents.map(&:id)
+      end
+    end
+
+    describe "#parents" do
+      it "returns an empty array when there are no parents" do
+        expect(subject.parents).to eq []
+      end
+
+      it "finds the children by id" do
+        subject.parent_ids = parents.map(&:id)
+        expect(subject.parents).to eq parents
+      end
+
+      it "is an accessor" do
+        subject.parents = parents
+        expect(subject.parents).to eq parents
+      end
+
+      context "finds records with the specified id" do
+        let(:child) { Child.create! }
+
+        it "as the whole json array" do
+          parent = Parent.create(children: [child])
+          expect(child.parents).to eq [parent]
+        end
+
+        it "at the beginning of the json array" do
+          parent = Parent.create(children: [child, Child.create!])
+          expect(child.parents).to eq [parent]
+        end
+
+        it "in the middle of the json array" do
+          parent = Parent.create(children: [Child.create!, child, Child.create!])
+          expect(child.parents).to eq [parent]
+        end
+
+        it "at the end of the json array" do
+          parent = Parent.create(children: [Child.create!, child])
+          expect(child.parents).to eq [parent]
+        end
+      end
+    end
+
+    describe "#parents?" do
+      it "returns false when there are no parents" do
+        expect(subject.parents?).to be_falsey
+      end
+
+      it "returns true when there are parents" do
+        subject.parents = parents
+        expect(subject.parents?).to be_truthy
+      end
+    end
+  end
+
+  describe ".has_many :parents, json_foreign_key: :fuzzy_ids" do
+    subject { Pet.create! }
+
+    let(:parents) { [Parent.create!, Parent.create!, Parent.create!] }
+
+    describe "#parent_ids" do
+      it "is empty by default" do
+        expect(subject.parent_ids).to eq []
+      end
+
+      it "is an accessor" do
+        subject.parent_ids = parents.map(&:id)
+        expect(subject.parent_ids).to eq parents.map(&:id)
+      end
+    end
+
+    describe "#parents" do
+      it "returns an empty array when there are no parents" do
+        expect(subject.parents).to eq []
+      end
+
+      it "finds the parents by id" do
+        subject.parent_ids = parents.map(&:id)
+        expect(subject.parents).to eq parents
+      end
+
+      it "is an accessor" do
+        subject.parents = parents
+        expect(subject.parents).to eq parents
+      end
+
+      context "finds records with the specified id" do
+        let(:pet) { Pet.create! }
+
+        it "as the whole json array" do
+          parent = Parent.create(fuzzies: [pet])
+          expect(pet.parents).to eq [parent]
+        end
+
+        it "at the beginning of the json array" do
+          parent = Parent.create(fuzzies: [pet, Pet.create!])
+          expect(pet.parents).to eq [parent]
+        end
+
+        it "in the middle of the json array" do
+          parent = Parent.create(fuzzies: [Pet.create!, pet, Pet.create!])
+          expect(pet.parents).to eq [parent]
+        end
+
+        it "at the end of the json array" do
+          parent = Parent.create(fuzzies: [Pet.create!, pet])
+          expect(pet.parents).to eq [parent]
+        end
+      end
+    end
+
+    describe "#parents?" do
+      it "returns false when there are no parents" do
+        expect(subject.parents?).to be_falsey
+      end
+
+      it "returns true when there are parents" do
+        subject.parents = parents
+        expect(subject.parents?).to be_truthy
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "byebug"
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end
+
+def silence_stream(stream)
+  old_stream = stream.dup
+  stream.reopen "/dev/null"
+  stream.sync = true
+  yield
+ensure
+  stream.reopen(old_stream)
+  old_stream.close
+end
+

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: active_record-json_associations
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Micah Geisel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-16 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.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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Instead of a many-to-many join table, serialize the ids into a JSON array.
+email:
+- micah@botandrose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record-json_associations.gemspec
+- lib/active_record/json_associations.rb
+- lib/active_record/json_associations/version.rb
+- spec/json_associations_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/botandrose/active_record-json_associations
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Instead of a many-to-many join table, serialize the ids into a JSON array.
+test_files:
+- spec/json_associations_spec.rb
+- spec/spec_helper.rb