base_form 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e17e616e68d129b4df560fbeefdc03a4ba59b6d9
-  data.tar.gz: 8d8abb13435b58487acc419ae77f4bdd4ca7f5fb
+SHA256:
+  metadata.gz: '040816d0c82a13955a6945f7939d4d3c4be7258bf19930182df388301ec76a6a'
+  data.tar.gz: ef90df7b6d22f743cdad184e228e26eac2dcf5610010b54cb16b6bc2b8346f5d
 SHA512:
-  metadata.gz: 92584db37f2726475eb530296972649793e615c45d69ee7f14e867af6aa51565fe76129c0d748aa8dec9967b5bf47c9daf47c2b12b00adc62178310680a6732a
-  data.tar.gz: 2215a7f4b46b1d2648979e2a7b3ce9bc1a78dc9082561d5912dae0a3451bfbbf8c9ffcbf2c74cf3eac26415b497aa0fbf686bd8a7c30553ffc6c30208b9e1861
+  metadata.gz: 6b05411ff5f7ebfa308e4398ba4ad5d9b810b5809c6f66070192f3f24a7dce275e4a9b8166fc996ccc845336f3cff79cf0f89fa177381ac0bbc0426cf8e18119
+  data.tar.gz: 2f60ffe258f35c7968a0add5affa30da6f7c267f93c482bbf2d57af5534e14318ceef8c000d942e2b95d216f649beeadf237488c18b63f5a2747e88c2722e636

data/README.md

@@ -1,10 +1,22 @@
 # BaseForm
 [![Code Climate](https://codeclimate.com/github/andrerpbts/base_form/badges/gpa.svg)](https://codeclimate.com/github/andrerpbts/base_form)
 [![Test Coverage](https://codeclimate.com/github/andrerpbts/base_form/badges/coverage.svg)](https://codeclimate.com/github/andrerpbts/base_form/coverage)
-[ ![Codeship Status for andrerpbts/base_form](https://app.codeship.com/projects/8d9be4e0-811f-0134-3da7-7e60ebb19227/status?branch=master)](https://app.codeship.com/projects/182157)
+[![Build Status](https://travis-ci.org/andrerpbts/base_form.svg?branch=master)](https://travis-ci.org/andrerpbts/base_form)
 
 A simple and small Form Objects Rails plugin for ActiveRecord based projects.
 
+## Why?
+In a development day-to-day basis, we commonly are confronted with situations where we
+need to save data in more than one database table, running it's own validations, and
+the validations of the all context together. In most cases a Form Object is a perfect
+solution to deliver those records in a fun and maintenable code.
+
+Actually, there's a lot of another gems to do that, like the great
+[reform](https://github.com/apotonick/reform) or
+[activeform-rails](https://github.com/GCorbel/activeform-rails), which are a more complete
+solution for this problem. But, if you are looking for something lighter, maybe this
+gem could fit well for you.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -23,18 +35,7 @@ $ gem install base_form
 ```
 
 ## Usage
-In a development day-to-day basis, we commonly are confronted with situation where we
-need to save data in more than one database table, running it's own validations, and
-the validations of the all context together. In most cases a Form Object is a perfect
-solution to deliver those records in a fun and maintenable code.
-
-Actually, there's a lot of another gems to do that, like the great
-[reform](https://github.com/apotonick/reform) or
-[activeform-rails](https://github.com/GCorbel/activeform-rails), which are a more complete
-solution for this problem. But, if you are looking for something lighter, maybe this
-gem could fit well for you.
-
-That said, let me show some simple examples to you. Let's suppose you want to create a
+Let's suppose you want to create a
 signup form (you can check this example in the dummy app on this gem specs), with
 receiving a user email, a user password, a user password confirmation, and a plan. In your
 signup form, you need to create an account for this user, associate it to a entrance plan
@@ -76,18 +77,19 @@ class SignupForm < BaseForm::Form
 end
 ```
 
-Now you may be asking: What about email and password? Did not should be validated as well?
-Well, you could, in fact, perform all validations in this form, but sometimes this can happen.
+Now you may be asking: What about email and password? Shouldn't they be validated as well?
+Well, you could, in fact, add all validations in this form instead put it in your models,
+but sometimes you don't have much control of that.
 Then, I'm showing here the case that `User` model has those validations. Don't be mad ok? :)
 
 The form validations are the first validations tha are performed before it try to persist
 something here. If this validation fails, for an example, the persist method will not even
-be called, and the talk is over. Otherwise, it wil try to persist your logic, that we'll
+be called, and we're done with it. Otherwise, it wil try to persist your logic, which we'll
 implement next.
 
 Ok, now, you need to set the records that you will persist here.
 In this case is the `:user` you want to save, and the `:account` you will want to associate
-to this user. So, you put it there (I recommend you let this in the top of the class to make
+to this user. So, you add it there (I recommend you let this in the top of the class to make
 it clear):
 
 ```ruby
@@ -98,16 +100,16 @@ class SignupForm < BaseForm::Form
 end
 ```
 
-This line will automatically generate `attr_readers` to each record there, and will add this
+This line will automatically generate `attr_readers` to each record there, and will add these
 symbols in an array called `form_records` in your class. To understand it better, let's talk
 about the `persist` implementation itself.
 
-By the rule, `persist` method is obligatory, and not implementing it, will cause your form
+By the rule, the `persist` method is obligatory, and not implementing it, will cause your form
 raise a `NotImplementedError` when calling `save` to it.
 
-All things written inside `persist` method, will automatically run in a ActiveRecord transaction,
-and if some record have its validation failed, this will perform a Rollback and deliver the form
-to you with those erros grouped through `errors` method, like any AR model you are already
+All things written inside `persist` method will automatically run in a ActiveRecord transaction,
+and if some record have its validation failed, this will perform a rollback and deliver the form
+to you with those errors grouped through `errors` method, like any AR model you are already
 familiar with.
 
 Let me stop to talk and show you something we can call as implementation of this:
@@ -134,13 +136,13 @@ class SignupForm < BaseForm::Form
 end
 ```
 
-So, here is the thing, see the variables names I've associated there, are the name os
-form_records I've defined before. It tries to create an account, setting a plan to it
+So, here is the thing: check the variables names I've associated there are the names of
+form_records I've defined before. It tries to create an account setting a plan to it
 and then tries to create a user associated to this brand new account.
 
-Is this `form_records` that will call each object associated here to check its errors,
-and group it in `errors` object in your form itself in case of some validation brakes,
-but if all is fine, the form instance is returned to you and you will be able to call
+This `form_records` will call each object associated here to check its errors,
+and group it in `errors` object in your form itself in case of some validation fails.
+If all is fine, the form instance is returned to you and you will be able to call
 methods like `persisted?`, `account`, `user`, `valid?` and etc...
 
 Are you still there? :D
@@ -176,8 +178,9 @@ class SignupForm < BaseForm
 end
 ```
 
-Hmmmm, seems to be good enough. I hope this helps someone in the same way it
-helped me. Thanks!
+Hmmm, this looks pretty nice!
+
+I hope this helps someone in the same way it helped me. Thanks!
 
 ## Contributing
 - Fork it

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -15,4 +17,3 @@ RDoc::Task.new(:rdoc) do |rdoc|
 end
 
 require 'bundler/gem_tasks'
-

data/lib/base_form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require dependencies gems
 require 'active_support'
 require 'active_model'

data/lib/base_form/form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BaseForm
   # This class is the main core functionality, by being an inheritable
   # class, which controls the form attributes assignments, validations

data/lib/base_form/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BaseForm
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,15 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: base_form
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - andrerpbts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-31 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bootsnap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.77.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.77.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -70,10 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A simple and small form objects Rails plugin
 test_files: []
-has_rdoc: