linker 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f9eb0fbcfcc447101d0f027e48f4629797cd3ac
-  data.tar.gz: efbb3242eaf1badba9f5fc47ec5f9292917fa8c8
+  metadata.gz: 60d42e098225ca9705b7b56aab2eb39efc69f97a
+  data.tar.gz: e55847169da1cdaf8c342be11cf93d52eec4279f
 SHA512:
-  metadata.gz: 2c46308f866502dcde44718902c531cc87507e318dfa7d3ee04ce87e657f1b9b56730d504b822de2cb14d401361df387f9dae22b25ce48d3ac4dd7662fa4f1a5
-  data.tar.gz: 2684c6ed01fa6b29c0046305c2e958442d2f0524c4ea0d97e8280016b9ba5c8fc7d767160ecca4c3c7705abd450183f6a951037d8f361e56f3f6b35d63e3c135
+  metadata.gz: 919e2f2cdc8bc5dbefd04856f046018cf3545a34fa7328ebfd5617e4049fa930af6785bf68835f573f60325fad996060bd00d6d14befa522c1c70783712000cb
+  data.tar.gz: 31c914abfdde1e38a63f0581e3b11b7ccb5a506bfe5750d02378c5775dbeaf7a66020ac6201d38b05703e02c4b4ac7ab7f255113282cf40e17ac334e2cd5fbba

data/.gitignore

@@ -13,4 +13,6 @@ Gemfile.lock
 *.o
 *.a
 mkmf.log
-*.gem
+*.gem
+.tags
+.tags_sorted_by_file

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## Next (unreleased)
+* Your contribution here.
+
+## 0.0.14 (2017-01-11)
+* Add support for models which have polymorphic associations.
+* Inferring main model (`main_model` is no more required).
+* Add _list for `has_and_belongs_to_many` associations.
+
+## 0.0.13 (2016-12-07)
+* Wrap `save` method in a database transaction.

data/Gemfile

@@ -9,7 +9,7 @@ rails = case rails_version
 when "master"
   {github: "rails/rails"}
 when "default"
-  "~> 5.0.0"
+  "~> 5.0.1"
 else
   "~> #{rails_version}"
 end

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Supported versions
 - Ruby 2.0+
-- Rails 3.1+ (including 4.x)
+- Rails 3.1+ (including 4 and 5)
 
 ## Usage
 
@@ -32,7 +32,7 @@ class User < ActiveRecord::Base
 
   has_one :address, dependent: :destroy
   has_one :profile
-  
+
   has_many :dependent_users, dependent: :destroy
   has_many :tasks, dependent: :destroy
 end
@@ -42,10 +42,11 @@ Create a form class through `rails g form whatever` or manually (it should inclu
 ```ruby
 class UserForm
   include Linker
-  
-  main_model User # or :user or 'User'
 
-  # Use relationship's name followed by "__" plus attribute's name 
+  # we infer the main model through the form's class name, but you can set manually like:
+  main_model User # or :user or 'User' ====> this line is optional
+
+  # Use relationship's name followed by "__" plus attribute's name
   # to validate has_one and belongs_to associations
   validates :name, :address__street, :company__name, presence: true
 end
@@ -82,7 +83,7 @@ Finally, you can use `fields_for` in order to create/edit associated fields and
 ```erb
 <%= form_for @user_form do |f| %>
   <%= f.text_field :name %>
-  
+
   <%= f.fields_for :tasks do |ta| %>
     <%= ta.hidden_field :id %>
     <%= ta.text_field :name %>
@@ -99,9 +100,9 @@ Finally, you can use `fields_for` in order to create/edit associated fields and
 
 ## How it works
 
-Linker will map all `has_one`, `has_many` and `belongs_to` associations from main model and let it ready to use.
+Linker will create delegators for all attributes of main model and its associations (`has_one`, `has_many` and `belongs_to`, except for polymorphic ones) and let it ready to use.
 
-Internally, it will include `ActiveModel::Model` if on Rails 4 or `ActiveModel::Validations` if on Rails < 4.
+Internally, it will include `ActiveModel::Model` if on Rails 4+ or `ActiveModel::Validations` if on Rails < 4.
 
 It will also create `params=` and `save` methods responsible to set new objects and save them. You can override these methods to get a custom behavior without worrying with delegations.
 
@@ -123,11 +124,9 @@ class CarsForm
   include Linker
   attr_accessor :before_save_checked
 
-  main_model :car
-
   validates :name, presence: true
 
-  def before_set_params params
+  def before_set_params(params)
     params['name'] = "#{params['name']} 2000"
   end
 
@@ -141,6 +140,10 @@ class CarsForm
 end
 ```
 
+## Roadmap
+- [ ] Create delegators only for specified associations (not all as now). For ie: `main_model :car, only_associations: [:customer]`
+- [ ] Rename this gem? Maybe.
+
 ## Contributing
 
 1. Fork it
@@ -151,4 +154,4 @@ end
 
 ## License
 
-This projected is licensed under the terms of the MIT license.
+This projected is licensed under the terms of the MIT license.

data/lib/linker/forms/attributes.rb

@@ -18,7 +18,8 @@ module Linker
       set_fields_for_methods(map_has_many_associations)
       set_fields_for_methods(map_belongs_to_associations, true)
       set_fields_for_methods(map_has_one_associations, true)
-      set_non_fields_for_methods(map_has_one_associations)
+      create_list_accessors_for(map_has_one_associations)
+      create_list_accessors_for(map_has_and_belongs_to_many_associations)
       set_remove_accessor(map_has_many_associations)
     end
 
@@ -35,6 +36,7 @@ module Linker
 
       [map_has_one_associations, map_belongs_to_associations].each do |rgroup|
         rgroup.each do |c|
+          return unless c[:columns]
           c[:columns].each do |cc|
             # ap "delegating #{cc} and #{cc}= for #{c[:name]}__#{cc}"
             self.class.__send__(:delegate, cc, "#{cc}=", to: c[:name].underscore.to_sym, prefix: "#{c[:name]}_")
@@ -57,9 +59,13 @@ module Linker
       @bt_assoc ||= @main_model.reflect_on_all_associations(:belongs_to)
     end
 
+    def get_has_and_belongs_to_many_associations
+      @habtm_assoc ||= @main_model.reflect_on_all_associations(:has_and_belongs_to_many)
+    end
+
     def filter_columns(model)
       f = model.columns.map(&:name)
-                       .delete_if{ |cn| USELESS_COLUMNS_REGEX.match(cn) }
+                       .delete_if { |cn| USELESS_COLUMNS_REGEX.match(cn) }
       # Get Paperclip attachments
       begin
         f = Paperclip::AttachmentRegistry.names_for(model).inject(f) do |t, c|
@@ -98,14 +104,9 @@ module Linker
       end
     end
 
-    def set_non_fields_for_methods(assoc_set)
+    def create_list_accessors_for(assoc_set)
       assoc_set.each do |c|
-        # ap "creating method #{c[:name]}_list"
-        self.class.send(:define_method, "#{c[:name]}_list") do
-          assoc = instance_variable_get("@#{get_main_model.to_s.underscore}")
-                  .send(c[:name])
-          assoc.present? && assoc.id || nil
-        end
+        self.class.__send__(:attr_accessor, "#{c[:name]}_list")
       end
     end
 
@@ -120,29 +121,33 @@ module Linker
       assoc.inject([]) do |t, c|
         t << {
           name: c.name.to_s,
-          klass: c.klass.name,
-          # delete_if remove useless attrs
-          columns: filter_columns(c.klass)
         }
+        unless c.options[:polymorphic]
+          t.last[:columns] = filter_columns(c.klass)
+          t.last[:klass] = c.klass.name
+        end
+        t
       end
     end
 
     def map_has_many_associations
       # Create an array with associated classes names and attrs
       @mapped_hm_assoc ||= map_associations(get_has_many_associations)
-      @mapped_hm_assoc
     end
 
     def map_belongs_to_associations
       # Create an array with associated classes names and attrs
       @mapped_bt_assoc ||= map_associations(get_belongs_to_associations)
-      @mapped_bt_assoc
     end
 
     def map_has_one_associations
       # Create an array with associated classes names and attrs
       @mapped_ho_assoc ||= map_associations(get_has_one_associations)
-      @mapped_ho_assoc
+    end
+
+    def map_has_and_belongs_to_many_associations
+      # Create an array with associated classes names and attrs
+      @mapped_habtm_assoc ||= map_associations(get_has_and_belongs_to_many_associations)
     end
   end
 end

data/lib/linker/forms/configuration_methods.rb

@@ -8,7 +8,7 @@ module Linker
       end
 
       def _main_model
-        @main_model
+        @main_model ||= self.name.split("Form").first
       end
     end
 

data/lib/linker/forms/params.rb

@@ -45,10 +45,13 @@ module Linker
               end
             end
           elsif param.match(/_list$/)
-            assoc = param.gsub(/_list$/, '')
-            if r = search_has_one(assoc)
-              final = value.present? ? r[:klass].constantize.send(:find, value) : nil
-              _get_main_model.send("#{assoc}=", final)
+            assoc = param.to_s.gsub(/_list$/, '')
+            if r = search_has_one(assoc) || r = search_has_and_belongs_to_many(assoc)
+              clean_value = value.is_a?(Array) ? value.reject(&:blank?) : value
+              # fill attr_accessor
+              self.send("#{param}=", clean_value)
+              final = clean_value.present? ? r[:klass].constantize.send(:find, clean_value) : nil
+              _get_main_model.send("#{assoc}=", final) if final.present?
             end
           else
             self.send("#{param}=", value)
@@ -97,7 +100,7 @@ module Linker
     private
 
     def _get_main_model
-      main_model ||= self.send(self.class._main_model.underscore)
+      @_get_main_model ||= self.send(self.class._main_model.underscore)
     end
 
     def search_has_one(name)
@@ -105,6 +108,11 @@ module Linker
       s.present? && s
     end
 
+    def search_has_and_belongs_to_many(name)
+      s = @mapped_habtm_assoc.detect { |c| c[:name] == name }
+      s.present? && s
+    end
+
     def search_has_many(name)
       s = @mapped_hm_assoc.detect { |c| c[:name] == name }
       s.present? && s

data/lib/linker/version.rb

@@ -1,3 +1,3 @@
 module Linker
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

data/spec/cars_form_spec.rb

@@ -1,22 +1,50 @@
 require 'spec_helper'
 
 describe CarsForm do
-  let(:cars_form) { CarsForm.new(Car.new) }
+  let(:cars_form) { described_class.new(Car.new) }
+  let!(:car_part1) { CarPart.create(name: "Part 1") }
+  let!(:car_part2) { CarPart.create(name: "Part 2") }
+
+  it { expect(cars_form.car_parts_list).to eq(nil) }
 
   context 'after_init callback' do
     it { expect(cars_form.name).to eq('default car name') }
   end
 
-  context 'callbacks' do
+  context 'callbacks and habtm _list' do
     before do
       cars_form.params = {
-        'name' => "Uno"
+        'name' => "Uno",
+        'car_parts_list' => [1, 2, ""]
       }
       cars_form.save
     end
 
     it { expect(cars_form.car.name).to eq('Uno 2000') }
+    if Rails.version.start_with?("3")
+      it { expect(cars_form.car.car_parts.map(&:id)).to eq([1,2]) }
+    else
+      it { expect(cars_form.car.car_parts.ids).to eq([1,2]) }
+    end
     it { expect(cars_form.before_save_checked).to eq(true) }
     it { expect(cars_form.after_save_checked).to eq(true) }
   end
-end
+
+  context 'validates empty habtm _list' do
+    before do
+      cars_form.params = {
+        'name' => "Uno",
+        'car_parts_list' => [""]
+      }
+      cars_form.save
+    end
+
+    it { expect(cars_form.car.name).to eq('Uno 2000') }
+    if Rails.version.start_with?("3")
+      it { expect(cars_form.car.car_parts.map(&:id)).to eq([]) }
+    else
+      it { expect(cars_form.car.car_parts.ids).to eq([]) }
+    end
+    it { expect(cars_form.errors.messages).to include(:car_parts_list) }
+  end
+end

data/spec/fake_app/active_record/models.rb

@@ -10,6 +10,8 @@ class User < ActiveRecord::Base
   has_many :dependent_users, dependent: :destroy
   has_many :my_tasks, dependent: :destroy, class_name: 'Task'
 
+  has_many :issues, as: :owner
+
   #has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }, :default_url => "/images/:style/missing.png"
   #validates_attachment_content_type :avatar, :content_type => /\Aimage\/.*\Z/
 end
@@ -20,6 +22,10 @@ end
 class Pet < ActiveRecord::Base
 end
 
+class Issue < ActiveRecord::Base
+  belongs_to :owner, polymorphic: true
+end
+
 class Company < ActiveRecord::Base
   has_many :users
 end
@@ -42,6 +48,10 @@ class Phone < ActiveRecord::Base
 end
 
 class Car < ActiveRecord::Base
+  has_and_belongs_to_many :car_parts
+end
+
+class CarPart < ActiveRecord::Base
 end
 
 #migrations
@@ -88,7 +98,7 @@ class CreateAllTables < ActiveRecord::Migration
       t.string :district
 
       t.references :user, index: true
-      
+
       t.timestamps
     end
 
@@ -96,7 +106,7 @@ class CreateAllTables < ActiveRecord::Migration
       t.string :name
 
       t.references :user, index: true
-      
+
       t.timestamps
     end
 
@@ -120,6 +130,25 @@ class CreateAllTables < ActiveRecord::Migration
       t.timestamps
     end
 
+    create_table :car_parts do |t|
+      t.string :name
+
+      t.timestamps
+    end
+
+    # join table
+    create_table :car_parts_cars, id: false do |t|
+      t.integer :car_id
+      t.integer :car_part_id
+    end
+    add_index :car_parts_cars, [:car_id, :car_part_id]
+
+    create_table :issues do |t|
+      t.string :name
+      t.integer :owner_id
+      t.string :owner_type
+    end
+
   end
 end
 ActiveRecord::Migration.verbose = false
@@ -138,4 +167,4 @@ bar = User.create(name: 'Bar')
 bar.my_tasks << Task.create(name: 'Task 1')
 bar.little_pet = Pet.create(name: 'Stuart')
 bar.profile = Profile.first
-bar.dependent_users << DependentUser.create(name: 'John', date_birth: Date.new(1990, 2, 1))
+bar.dependent_users << DependentUser.create(name: 'John', date_birth: Date.new(1990, 2, 1))

data/spec/fake_app/forms/cars_form.rb

@@ -8,11 +8,13 @@ class CarsForm
 
   validates :name, presence: true
 
+  validates :car_parts_list, presence: true
+
   def after_init
     self.name = 'default car name'
   end
 
-  def before_set_params params
+  def before_set_params(params)
     params['name'] = "#{params['name']} 2000"
   end
 
@@ -23,4 +25,4 @@ class CarsForm
   def after_save
     @after_save_checked = true
   end
-end
+end

data/spec/fake_app/forms/issue_form.rb

@@ -0,0 +1,5 @@
+require 'linker'
+
+class IssueForm
+  include Linker
+end

data/spec/fake_app/rails_app.rb

@@ -18,6 +18,7 @@ require_relative 'active_record/models'
 require_relative 'forms/dependent_user_form'
 require_relative 'forms/users_form'
 require_relative 'forms/cars_form'
+require_relative 'forms/issue_form'
 # controllers
 # class ApplicationController < ActionController::Base; end
 
@@ -25,4 +26,4 @@ require_relative 'forms/cars_form'
 #   def new
 #     @users_form = UserForm.new(User.new)
 #   end
-# end
+# end

data/spec/issue_form_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe IssueForm do
+  let(:issue_form) { described_class.new(Issue.new) }
+
+  it { expect(described_class._main_model).to eq('Issue') }
+
+  describe "attributes" do
+    subject { issue_form.issue }
+    it { expect(subject).to be_an(Issue) }
+    it { expect(subject.name).to eq(nil) }
+    it { expect(subject.owner_id).to eq(nil) }
+    it { expect(subject.owner_type).to eq(nil) }
+  end
+
+  describe "save" do
+    let(:user) { User.create(name: "John") }
+    let(:params) do
+      {
+        name: "Bla",
+        owner_id: user.id,
+        owner_type: user.class.name
+      }
+    end
+    before do
+      issue_form.params = params
+      issue_form.save
+    end
+
+    it { expect(Issue.count).to eq(1) }
+
+    subject { Issue.last }
+    it { expect(subject.name).to eq("Bla") }
+    it { expect(subject.owner_id).to eq(user.id) }
+    it { expect(subject.owner_type).to eq("User") }
+  end
+end

data/spec/spec_helper.rb

@@ -4,4 +4,9 @@ require 'rails'
 
 if defined? Rails
   require 'fake_app/rails_app'
-end
+end
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/spec/users_form_spec.rb

@@ -16,7 +16,7 @@ describe UsersForm do
 
   it { expect(users_form).to respond_to(:user) }
   subject(:user) { users_form.user }
-  it { expect(user).to be_an(User) }  
+  it { expect(user).to be_an(User) }
 
   it { expect(users_form).to respond_to(:params=) }
   it { expect(users_form).to respond_to(:save) }
@@ -75,30 +75,30 @@ describe UsersForm do
   it { expect(family).to be_an(Family) }
 
   context 'new' do
-    it { expect(user.persisted?).to eq(false) }  
-  
+    it { expect(user.persisted?).to eq(false) }
+
     it { expect(users_form.save).to eq(false) }
     it { expect(users_form).not_to be_valid }
     it do
       users_form.save
-      expect(users_form.errors.full_messages).to include("Name can't be blank") 
+      expect(users_form.errors.full_messages).to include("Name can't be blank")
     end
 
-    it { expect(dependent_users_sample.persisted?).to eq(false) }  
+    it { expect(dependent_users_sample.persisted?).to eq(false) }
 
-    it { expect(tasks_sample.persisted?).to eq(false) }  
+    it { expect(tasks_sample.persisted?).to eq(false) }
 
-    it { expect(address.persisted?).to eq(false) }  
+    it { expect(address.persisted?).to eq(false) }
 
     it { expect(profile_list).to eq(nil) }
 
     it { expect(my_phone_list).to eq(nil) }
 
-    it { expect(pet.persisted?).to eq(false) }  
+    it { expect(pet.persisted?).to eq(false) }
 
-    it { expect(company.persisted?).to eq(false) }  
+    it { expect(company.persisted?).to eq(false) }
 
-    it { expect(family.persisted?).to eq(false) }  
+    it { expect(family.persisted?).to eq(false) }
   end
 
   context 'create' do
@@ -129,9 +129,9 @@ describe UsersForm do
 
     it { expect(dependent_users_sample.persisted?).to eq(true) }
     it { expect(dependent_users_sample.name).to eq('') }
-    
-    it { expect(profile_list).to eq(1) }
-    it { expect(my_phone_list).to eq(2) }
+
+    it { expect(profile_list).to eq('1') }
+    it { expect(my_phone_list).to eq('2') }
 
     it { expect(pet).to be_a(Pet)}
     it { expect(pet.persisted?).to be(true)}
@@ -197,16 +197,16 @@ describe UsersForm do
 
     it { expect(users_form_existing_user_user.persisted?).to eq(true)}
     it { expect(users_form_existing_user_user.name).to eq('Bar')}
-    
+
     it { expect(users_form_existing_user_company.persisted?).to be(true) }
     it { expect(users_form_existing_user_company.name).to eq('My Company') }
     it { expect(users_form_existing_user_company.website).to eq('mycompany.com') }
 
     it { expect(users_form_existing_user_family.persisted?).to be(true) }
     it { expect(users_form_existing_user_family.last_name).to eq('Milan') }
-    
-    it { expect(users_form_existing_user.profile_list).to be(nil) }
-    it { expect(users_form_existing_user.my_phone_list).to be(nil) }
+
+    it { expect(users_form_existing_user.profile_list).to eq('') }
+    it { expect(users_form_existing_user.my_phone_list).to eq('') }
 
     it { expect(users_form_existing_user_pet).to be_a(Pet) }
     it { expect(users_form_existing_user_pet.persisted?).to be(true) }
@@ -217,4 +217,4 @@ describe UsersForm do
     it { expect(users_form_existing_user_address.street).to eq('') }
     it { expect(users_form_existing_user_address.district).to eq('') }
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linker
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Glauco Custódio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -132,6 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -154,8 +155,10 @@ files:
 - spec/fake_app/config/database.yml
 - spec/fake_app/forms/cars_form.rb
 - spec/fake_app/forms/dependent_user_form.rb
+- spec/fake_app/forms/issue_form.rb
 - spec/fake_app/forms/users_form.rb
 - spec/fake_app/rails_app.rb
+- spec/issue_form_spec.rb
 - spec/spec_helper.rb
 - spec/users_form_spec.rb
 homepage: https://github.com/glaucocustodio/linker
@@ -178,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A wrapper to form objects in ActiveRecord. Forget accepts_nested_attributes_for.
@@ -189,7 +192,10 @@ test_files:
 - spec/fake_app/config/database.yml
 - spec/fake_app/forms/cars_form.rb
 - spec/fake_app/forms/dependent_user_form.rb
+- spec/fake_app/forms/issue_form.rb
 - spec/fake_app/forms/users_form.rb
 - spec/fake_app/rails_app.rb
+- spec/issue_form_spec.rb
 - spec/spec_helper.rb
 - spec/users_form_spec.rb
+has_rdoc: