mini_form 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fae1bbe2eb9f254e0315e13364a0d9a19a87515061f066a37fd89689be9c657
-  data.tar.gz: 34c5ac1537cf058c0c67cdaa7ef4c88dd7aaaef63412cbabddbad5e13be73435
+  metadata.gz: 05110a58fa226872117674c65d40a1312b20f368d2c3091abcf1f1d76ca8556f
+  data.tar.gz: 5046659d5998b2786b304bb47e0190dd21605863be6482106c9bb259453847e7
 SHA512:
-  metadata.gz: ada501cc629ff6fd8701162248d095868bf2a7a9ac0e7e23f74caae5d08d1f8cbd31d9202fd47f52283cbb3117cd8c0d1a2705b9c074a09a6c95cb622ac2e4ee
-  data.tar.gz: 8cb38e2bf06594be100078b2d2b0ee10c4d5a356808ba4249fc2f63f060478619c97dc8d776004d20c5f52cb2b1dfef5b93099ca9307379c7921006a40bfa0ee
+  metadata.gz: 8ebdb289c2f4a3c975be13ae53e52032ff33130658cdf9b580373f9cc988d60eb8e62732280c5c71889aeac7021c50857957bfd459b689e27f8716c45e142c64
+  data.tar.gz: '078b887c19a8049f34ff73cbe6bc1a686f5b9219ee7e499c6176de023c80ad283529d4c5b56b3a673688b08ce175f0ca6d893e02034b39f9ca3d5a10b97ed3be'

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@0a29871fe2b0200a17a4497bae54fe5df0d973aa # v1.115.3
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run linters
+        run: bundle exec rubocop
+
+      - name: Run tests
+        run: bundle exec rspec spec
+

data/.rubocop.yml

@@ -1,34 +1,34 @@
 require: rubocop-rspec
 
-Rails:
-  Enabled: true
+AllCops:
   Exclude:
-    - example/db/**/*
-    - example/config/**/*
-    - search_object.gemspec
+    - mini_form.gemspec
+
+  SuggestExtensions: false
+  NewCops: disable
 
 # Disables "Module definition is too long"
-ModuleLength:
+Metrics/ModuleLength:
   Enabled: false
 
 # Disables "Line is too long"
-LineLength:
+Layout/LineLength:
   Enabled: false
 
 # Disables "Method is too long"
-MethodLength:
+Metrics/MethodLength:
   Enabled: false
 
 # Disables "Assignment Branch Condition size for included is too high"
-AbcSize:
+Metrics/AbcSize:
   Enabled: false
 
 # Disables "Block has too many lines"
-BlockLength:
+Metrics/BlockLength:
   Enabled: false
 
 # Disables "Missing top-level class documentation comment"
-Documentation:
+Style/Documentation:
   Enabled: false
 
 # Disables "Use each_with_object instead of inject"
@@ -43,10 +43,6 @@ Style/CollectionMethods:
 Style/PercentLiteralDelimiters:
   Enabled: false
 
-# Disables "Use tr instead of gsubs"
-Performance/StringReplacement:
-  Enabled: false
-
 # Disables "Example has too many expectations"
 RSpec/MultipleExpectations:
   Enabled: false
@@ -54,3 +50,9 @@ RSpec/MultipleExpectations:
 # Disables "Example has too many lines"
 RSpec/ExampleLength:
   Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 0.2.5
+
+* Added `main_model` (@rstankov)
+
 ## Version 0.2.4
 
 * Rails 6+ support (@emilov)

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,6 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/mini_form.svg)](http://badge.fury.io/rb/mini_form)
 [![Code Climate](https://codeclimate.com/github/RStankov/MiniForm.svg)](https://codeclimate.com/github/RStankov/MiniForm)
-[![Build Status](https://secure.travis-ci.org/RStankov/MiniForm.svg)](http://travis-ci.org/RStankov/MiniForm)
 [![Code coverage](https://coveralls.io/repos/RStankov/MiniForm/badge.svg?branch=master)](https://coveralls.io/r/RStankov/MiniForm)
 
 # MiniForm
@@ -194,6 +193,26 @@ class SignUpForm
 end
 ```
 
+### Using in forms
+
+Using `main_model` will delegate `id`, `to_param`, `persisted?` and `new_record?` to the model. Allowing you to use it in forms.
+
+```ruby
+class SignUpForm
+  include MiniForm::Model
+
+  main_model :user
+
+  def initialize
+    @user = User.new(account: @account)
+  end
+end
+```
+
+```eruby
+<% form_for SignUpForm.new %>
+```
+
 ### Delegating model attributes
 
 ```ruby
@@ -203,7 +222,7 @@ class SignUpForm
   model :user, attributes: %i(name email), read: %i(id)
 
   def initialize
-    @user    = User.new account: @account
+    @user = User.new(account: @account)
   end
 end
 ```

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/lib/mini_form/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MiniForm
   class InvalidForm < StandardError
     attr_reader :errors

data/lib/mini_form/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/all'
 require 'active_model'
 
@@ -73,6 +75,7 @@ module MiniForm
 
     def update!(attributes = {})
       raise InvalidForm, self unless update attributes
+
       self
     end
 
@@ -156,7 +159,7 @@ module MiniForm
         end
       end
 
-      def model(name, attributes: [], read: [], prefix: nil, allow_nil: nil, save: false) # rubocop:disable ParameterLists
+      def model(name, attributes: [], read: [], prefix: nil, allow_nil: nil, save: false) # rubocop:disable Metrics/ParameterLists
         attr_accessor name
 
         attributes(*attributes, delegate: name, prefix: prefix, allow_nil: allow_nil) unless attributes.empty?
@@ -167,6 +170,12 @@ module MiniForm
 
         models_to_save << name if save
       end
+
+      def main_model(model_name, **args)
+        delegate :id, :persisted?, :to_param, :new_record?, to: model_name
+
+        model model_name, **args
+      end
     end
   end
 end

data/lib/mini_form/nested_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 
 module MiniForm

data/lib/mini_form/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MiniForm
-  VERSION = '0.2.4'.freeze
+  VERSION = '0.2.5'
 end

data/lib/mini_form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mini_form/version'
 require 'mini_form/model'
 require 'mini_form/errors'

data/mini_form.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 2.1.4'
   spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 2.14'
-  spec.add_development_dependency 'rspec-mocks', '>= 2.12.3'
+  spec.add_development_dependency 'rspec', '3.12.0'
+  spec.add_development_dependency 'rspec-mocks', '3.12.0'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'

data/spec/mini_form/nested_validator_spec.rb

@@ -1,28 +1,32 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-module MiniForm
-  describe NestedValidator do
-    class User
-      include ActiveModel::Model
+module SpecSupport
+  class Person
+    include ActiveModel::Model
 
-      attr_accessor :name
+    attr_accessor :name
 
-      validates :name, presence: true
-    end
+    validates :name, presence: true
+  end
 
-    class Record
-      include ActiveModel::Validations
+  class Record
+    include ActiveModel::Validations
 
-      attr_accessor :user
+    attr_accessor :user
 
-      def initialize(user)
-        @user = user
-      end
+    def initialize(user)
+      @user = user
     end
+  end
+end
 
-    let(:validator) { NestedValidator.new(attributes: [:user]) }
-    let(:user)      { User.new }
-    let(:record)    { Record.new(user) }
+module MiniForm
+  describe NestedValidator do
+    let(:validator) { described_class.new(attributes: [:user]) }
+    let(:user)      { SpecSupport::Person.new }
+    let(:record)    { SpecSupport::Record.new(user) }
 
     it 'copies errors from submodel to model' do
       validator.validate(record)

data/spec/mini_form_spec.rb

@@ -1,42 +1,96 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-module MiniForm
-  describe Model do
-    let(:user) { User.new id: 1, name: 'name', age: 28 }
+module SpecSupport
+  class User
+    include ActiveModel::Model
 
-    class User
-      include ActiveModel::Model
+    attr_accessor :id, :name, :age
 
-      attr_accessor :id, :name, :age
+    validates :name, presence: true
 
-      validates :name, presence: true
+    def to_param
+      "user-#{id}"
     end
 
-    Example = Class.new do
-      include Model
+    def persisted?
+      id.present?
+    end
 
-      attributes :name, :price
+    def new_record?
+      !persisted?
     end
+  end
 
-    ExampleWithDelegate = Class.new do
-      include Model
+  class Example
+    include MiniForm::Model
 
-      attr_reader :user
+    attributes :name, :price
+  end
 
-      attributes :name, delegate: :user
-      attributes :id, delegate: :user, prefix: true
-      attributes :name, delegate: :user, prefix: 'full'
+  class ExampleWithDelegate
+    include MiniForm::Model
 
-      def initialize(user)
-        @user = user
-      end
+    attr_reader :user
+
+    attributes :name, delegate: :user
+    attributes :id, delegate: :user, prefix: true
+    attributes :name, delegate: :user, prefix: 'full'
+
+    def initialize(user)
+      @user = user
+    end
+  end
+
+  class ExampleWithModel
+    include MiniForm::Model
+
+    model :user, attributes: %i(name), read: %i(id)
+
+    def initialize(user)
+      self.user = user
     end
+  end
+
+  class ExampleForUpdate
+    include MiniForm::Model
+
+    attributes :name
+
+    validates :name, presence: true
+  end
+
+  class ExampleForSave
+    include MiniForm::Model
+
+    model :user, attributes: %i(name), save: true
+
+    def initialize(user:)
+      self.user = user
+    end
+  end
+
+  class ExampleFormModel
+    include MiniForm::Model
+
+    main_model :user
+
+    def initialize(user:)
+      self.user = user
+    end
+  end
+end
+
+module MiniForm
+  describe Model do
+    let(:user) { SpecSupport::User.new id: 1, name: 'name', age: 28 }
 
     describe 'acts as ActiveModel' do
       include ActiveModel::Lint::Tests
 
       before do
-        @model = Example.new
+        @model = SpecSupport::Example.new
       end
 
       def assert(condition, message = nil)
@@ -79,24 +133,24 @@ module MiniForm
 
     describe '.attributes' do
       it 'generates getters' do
-        object = Example.new name: 'value'
+        object = SpecSupport::Example.new name: 'value'
         expect(object.name).to eq 'value'
       end
 
       it 'generates setters' do
-        object = Example.new
+        object = SpecSupport::Example.new
         object.name = 'value'
 
         expect(object.name).to eq 'value'
       end
 
       it 'can delegate getter' do
-        object = ExampleWithDelegate.new user
+        object = SpecSupport::ExampleWithDelegate.new user
         expect(object.name).to eq user.name
       end
 
       it 'can delegate setter' do
-        object = ExampleWithDelegate.new user
+        object = SpecSupport::ExampleWithDelegate.new user
 
         object.name = 'New Name'
 
@@ -106,71 +160,75 @@ module MiniForm
     end
 
     describe '.model' do
-      ExampleWithModel = Class.new do
-        include Model
-
-        model :user, attributes: %i(name), read: %i(id)
-
-        def initialize(user)
-          self.user = user
-        end
-      end
-
       it 'generates model accessors' do
-        object = ExampleWithModel.new user
+        object = SpecSupport::ExampleWithModel.new user
         expect(object.user).to eq user
       end
 
       it 'can delegate only a reader' do
-        object = ExampleWithModel.new user
+        object = SpecSupport::ExampleWithModel.new user
 
         expect(object).not_to respond_to :id=
         expect(object.id).to eq user.id
       end
 
       it 'can delegate model attributes' do
-        object = ExampleWithModel.new user
+        object = SpecSupport::ExampleWithModel.new user
         expect(object.name).to eq user.name
       end
 
       it 'performs nested validation for model' do
-        user   = User.new
-        object = ExampleWithModel.new user
+        user   = SpecSupport::User.new
+        object = SpecSupport::ExampleWithModel.new user
 
         expect(object).not_to be_valid
         expect(object.errors[:name]).to be_present
       end
     end
 
+    describe '.main_model' do
+      it 'delegates Rails form attributes to the model' do
+        user   = SpecSupport::User.new
+        object = SpecSupport::ExampleFormModel.new(user: user)
+
+        expect(object).to have_attributes(
+          id: user.id,
+          to_param: user.to_param,
+          persisted?: user.persisted?,
+          new_record?: user.new_record?
+        )
+      end
+    end
+
     describe '.attributes_names' do
       it 'returns attribute names' do
-        expect(Example.attribute_names).to eq %i(name price)
+        expect(SpecSupport::Example.attribute_names).to eq %i(name price)
       end
 
       it 'can handle prefixes' do
-        expect(ExampleWithDelegate.attribute_names).to include :user_id
-        expect(ExampleWithDelegate.attribute_names).to include :full_name
+        expect(SpecSupport::ExampleWithDelegate.attribute_names).to include :user_id
+        expect(SpecSupport::ExampleWithDelegate.attribute_names).to include :full_name
       end
     end
 
     describe '#initialize' do
       it 'can be called with no arguments' do
-        expect { Example.new }.not_to raise_error
+        expect { SpecSupport::Example.new }.not_to raise_error
       end
 
       it 'assign the passed attributes' do
-        object = Example.new price: '$5'
+        object = SpecSupport::Example.new price: '$5'
 
         expect(object.price).to eq '$5'
       end
 
       it 'ignores invalid attributes' do
-        expect { Example.new invalid: 'attribute' }.not_to raise_error
+        expect { SpecSupport::Example.new invalid: 'attribute' }.not_to raise_error
       end
 
       it 'handles HashWithIndifferentAccess hashes' do
         hash   = ActiveSupport::HashWithIndifferentAccess.new 'price' => '$5'
-        object = Example.new hash
+        object = SpecSupport::Example.new hash
 
         expect(object.price).to eq '$5'
       end
@@ -178,7 +236,7 @@ module MiniForm
 
     describe '#attributes' do
       it 'returns attributes' do
-        object = Example.new name: 'iPhone', price: '$5'
+        object = SpecSupport::Example.new name: 'iPhone', price: '$5'
         expect(object.attributes).to eq name: 'iPhone', price: '$5'
       end
     end
@@ -186,14 +244,14 @@ module MiniForm
     ['attributes=', 'assign_attributes'].each do |method_name|
       describe "##{method_name}" do
         it 'sets attributes' do
-          object = Example.new
+          object = SpecSupport::Example.new
           object.public_send method_name, name: 'iPhone', price: '$5'
 
           expect(object.attributes).to eq name: 'iPhone', price: '$5'
         end
 
         it 'ignores not listed attributes' do
-          object = Example.new
+          object = SpecSupport::Example.new
           object.public_send method_name, invalid: 'value'
 
           expect(object.attributes).to eq name: nil, price: nil
@@ -202,38 +260,20 @@ module MiniForm
     end
 
     describe '#update' do
-      ExampleForUpdate = Class.new do
-        include Model
-
-        attributes :name
-
-        validates :name, presence: true
-      end
-
-      ExampleForSave = Class.new do
-        include Model
-
-        model :user, attributes: %i(name), save: true
-
-        def initialize(user:)
-          self.user = user
-        end
-      end
-
       it 'updates attributes' do
-        object = ExampleForUpdate.new name: 'value'
+        object = SpecSupport::ExampleForUpdate.new name: 'value'
 
         expect { object.update(name: 'new value') }.to change { object.name }.to 'new value'
       end
 
       it 'returns true when validations pass' do
-        object = ExampleForUpdate.new name: 'value'
+        object = SpecSupport::ExampleForUpdate.new name: 'value'
 
         expect(object.update).to eq true
       end
 
       it 'calls "perfom" method when validation pass' do
-        object = ExampleForUpdate.new name: 'value'
+        object = SpecSupport::ExampleForUpdate.new name: 'value'
 
         allow(object).to receive(:perform)
 
@@ -243,7 +283,7 @@ module MiniForm
       end
 
       it 'calls "save" for the model' do
-        object = ExampleForSave.new user: user
+        object = SpecSupport::ExampleForSave.new user: user
 
         allow(user).to receive(:save!)
 
@@ -253,7 +293,7 @@ module MiniForm
       end
 
       it 'supports update callbacks' do
-        object = ExampleForUpdate.new name: 'value'
+        object = SpecSupport::ExampleForUpdate.new name: 'value'
 
         allow(object).to receive(:before_update)
         allow(object).to receive(:after_update)
@@ -265,7 +305,7 @@ module MiniForm
       end
 
       it 'supports legacy assig callbacks' do
-        object = ExampleForUpdate.new
+        object = SpecSupport::ExampleForUpdate.new
 
         allow(object).to receive(:before_assigment)
         allow(object).to receive(:after_assigment)
@@ -277,7 +317,7 @@ module MiniForm
       end
 
       it 'supports assign callbacks' do
-        object = ExampleForUpdate.new
+        object = SpecSupport::ExampleForUpdate.new
 
         allow(object).to receive(:before_assignment)
         allow(object).to receive(:after_assignment)
@@ -289,13 +329,13 @@ module MiniForm
       end
 
       it 'returns false when validations fail' do
-        object = ExampleForUpdate.new name: nil
+        object = SpecSupport::ExampleForUpdate.new name: nil
 
         expect(object.update).to eq false
       end
 
       it 'does not call "perfom" method when validation fail' do
-        object = ExampleForUpdate.new name: nil
+        object = SpecSupport::ExampleForUpdate.new name: nil
 
         allow(object).to receive(:perform)
 
@@ -307,12 +347,12 @@ module MiniForm
 
     describe '#update!' do
       it 'returns self' do
-        object = Example.new
+        object = SpecSupport::Example.new
         expect(object.update!).to eq object
       end
 
       it 'calls update with given arguments' do
-        object = Example.new
+        object = SpecSupport::Example.new
 
         allow(object).to receive(:update).and_return true
 
@@ -322,7 +362,7 @@ module MiniForm
       end
 
       it 'raises error when update fails' do
-        object = Example.new
+        object = SpecSupport::Example.new
 
         allow(object).to receive(:update).and_return false
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 
 if ENV['TRAVIS']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_form
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2024-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -56,30 +56,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.3
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.3
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -129,11 +129,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".projections.json"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Easy to use form objects in Rails projects

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.5
-  - 2.3.3
-  - 2.4.0
-script:
-  - bundle exec rubocop
-  - bundle exec rspec spec
-sudo: false
-cache: bundle
-notifications:
-  email: false