active_objects 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +123 -0
- data/Rakefile +2 -0
- data/active_objects.gemspec +25 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/active_objects.rb +74 -0
- metadata +82 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ae45caaa6e61af205f7a156bc598bb8a5f04be1443457c206cd546df499fc34f
|
4
|
+
data.tar.gz: 396d75c4eb2aecae60b19857dc5266f95d66963faa23aaec26731491daa8f3da
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 112cbce75ca1fddb13bbb4a367cb172e20c3194cf89947ebfc5bfde7ed648882ef9149736a39faca102eb9524e10363856a5b3ec31085acf35ee449d465ec98c
|
7
|
+
data.tar.gz: 73aeea2c47c40eac1ec3cbed191d8d03c82b1301cd1a4cad1293a557cdb4679c8cfbb9f219f2dc53923bd398a7a4e97b12afdd6dd56f12d2519aad6a4e1a8e45
|
data/.gitignore
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at kamilsopata@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2018 Kamil Sopata
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,123 @@
|
|
1
|
+
# ActiveObjects
|
2
|
+
Form objects for Ruby on Rails.
|
3
|
+
* Works with ActiveRecord
|
4
|
+
* i18n support
|
5
|
+
* Easy to implement
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'active_objects'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
### Rails:
|
22
|
+
|
23
|
+
#### Create first form object
|
24
|
+
Create a forms directory, for example: app/forms and create your first form object there:
|
25
|
+
```ruby
|
26
|
+
class ProductForm < ActiveObjects
|
27
|
+
validates :name, presence: true
|
28
|
+
|
29
|
+
private
|
30
|
+
|
31
|
+
def object_class
|
32
|
+
Product
|
33
|
+
end
|
34
|
+
|
35
|
+
def permitted_attributes
|
36
|
+
%i[name]
|
37
|
+
end
|
38
|
+
end
|
39
|
+
```
|
40
|
+
Where object_class (for model class) and permitted_attributes (for model attributes from the form) are required methods.
|
41
|
+
|
42
|
+
To load forms, add this line to config/application.rb
|
43
|
+
```ruby
|
44
|
+
config.autoload_paths << Rails.root.join('app/forms/**/')
|
45
|
+
```
|
46
|
+
|
47
|
+
In the form object you have access to all [ActiveModel validations](https://api.rubyonrails.org/classes/ActiveModel/Validations.html)
|
48
|
+
|
49
|
+
#### Update your controller actions
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
def new
|
53
|
+
@product_form = ProductForm.new
|
54
|
+
end
|
55
|
+
|
56
|
+
def edit
|
57
|
+
product = Product.find(params[:id])
|
58
|
+
@product_form = ProductForm.new(product)
|
59
|
+
end
|
60
|
+
|
61
|
+
def create
|
62
|
+
@product_form = ProductForm.new(product_params)
|
63
|
+
if @product_form.save
|
64
|
+
redirect_to products_path
|
65
|
+
else
|
66
|
+
render :new
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
def update
|
71
|
+
product = Product.find(params[:id])
|
72
|
+
@product_form = ProductForm.new(product)
|
73
|
+
if @product_form.update(product_params)
|
74
|
+
redirect_to products_path
|
75
|
+
else
|
76
|
+
render :edit
|
77
|
+
end
|
78
|
+
end
|
79
|
+
```
|
80
|
+
#### Update your views
|
81
|
+
|
82
|
+
New:
|
83
|
+
```ruby
|
84
|
+
= form_for(@product_form, url: products_path, method: :post) do |f|
|
85
|
+
= f.text_field :name
|
86
|
+
%small= f.object.errors[:name]&.first
|
87
|
+
= f.submit
|
88
|
+
```
|
89
|
+
Edit:
|
90
|
+
```ruby
|
91
|
+
= form_for(@product_form, url: product_path(@product), method: :patch) do |f|
|
92
|
+
= f.text_field :name
|
93
|
+
%small= f.object.errors[:name]&.first
|
94
|
+
= f.submit
|
95
|
+
```
|
96
|
+
|
97
|
+
#### i18n
|
98
|
+
|
99
|
+
Activeform uses standard ActiveRecord i18n scope for error messages and model names and attributes.
|
100
|
+
```yaml
|
101
|
+
en:
|
102
|
+
activerecord:
|
103
|
+
attributes:
|
104
|
+
Product:
|
105
|
+
name: Name
|
106
|
+
price: Price
|
107
|
+
models:
|
108
|
+
product:
|
109
|
+
one: Product
|
110
|
+
other: Products
|
111
|
+
```
|
112
|
+
|
113
|
+
## Contributing
|
114
|
+
|
115
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/kamilsdz/active_objects. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
116
|
+
|
117
|
+
## License
|
118
|
+
|
119
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
120
|
+
|
121
|
+
## Code of Conduct
|
122
|
+
|
123
|
+
Everyone interacting in the Activeform project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kamilsdz/active_objects/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
lib = File.expand_path("../lib", __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
|
4
|
+
Gem::Specification.new do |spec|
|
5
|
+
spec.name = "active_objects"
|
6
|
+
spec.version = "0.1.3"
|
7
|
+
spec.authors = ["Kamil Sopata"]
|
8
|
+
spec.email = ["kamilsopata@gmail.com"]
|
9
|
+
spec.summary = %q{Form objects for ActiveRecord models.}
|
10
|
+
spec.description = %q{Form objects for ActiveRecord models.}
|
11
|
+
spec.homepage = "https://github.com/kamilsdz/active_objects"
|
12
|
+
spec.license = "MIT"
|
13
|
+
|
14
|
+
# Specify which files should be added to the gem when it is released.
|
15
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
16
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
17
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
end
|
19
|
+
spec.bindir = "exe"
|
20
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
21
|
+
spec.require_paths = ["lib"]
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
24
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
25
|
+
end
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "active_objects"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
class ActiveObjects
|
2
|
+
include ActiveModel::Model
|
3
|
+
|
4
|
+
class << self
|
5
|
+
def i18n_scope
|
6
|
+
:activerecord
|
7
|
+
end
|
8
|
+
|
9
|
+
def lookup_ancestors
|
10
|
+
[new.send(:object_class)]
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
def initialize(attr = {})
|
15
|
+
generate_attr_accessors
|
16
|
+
if attr[:id].present?
|
17
|
+
@object = object_class.find(attr[:id])
|
18
|
+
generate_instances_for @object
|
19
|
+
else
|
20
|
+
super(attr)
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
def save
|
25
|
+
if valid?
|
26
|
+
persist!
|
27
|
+
else
|
28
|
+
false
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
def update(attr)
|
33
|
+
assign_attributes(attr)
|
34
|
+
if valid?
|
35
|
+
update_form!
|
36
|
+
else
|
37
|
+
false
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
private
|
42
|
+
|
43
|
+
def object_class
|
44
|
+
raise 'Not implemented object_class method'
|
45
|
+
end
|
46
|
+
|
47
|
+
def permitted_attributes
|
48
|
+
raise 'Not implemented permitted_attributes method'
|
49
|
+
end
|
50
|
+
|
51
|
+
def hash_attributes
|
52
|
+
{}.tap { |hash| permitted_attributes.each { |attr| hash[attr] = send(attr) } }
|
53
|
+
end
|
54
|
+
|
55
|
+
def generate_attr_accessors
|
56
|
+
permitted_attributes.each do |attr|
|
57
|
+
class_eval { attr_accessor attr }
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
def generate_instances_for(_object)
|
62
|
+
permitted_attributes.each do |attr|
|
63
|
+
instance_variable_set("@#{attr}", @object.send(attr))
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
def persist!
|
68
|
+
object_class.create hash_attributes
|
69
|
+
end
|
70
|
+
|
71
|
+
def update_form!
|
72
|
+
@object.update hash_attributes
|
73
|
+
end
|
74
|
+
end
|
metadata
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: active_objects
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.3
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kamil Sopata
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-10-27 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.16'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.16'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
description: Form objects for ActiveRecord models.
|
42
|
+
email:
|
43
|
+
- kamilsopata@gmail.com
|
44
|
+
executables: []
|
45
|
+
extensions: []
|
46
|
+
extra_rdoc_files: []
|
47
|
+
files:
|
48
|
+
- ".gitignore"
|
49
|
+
- CODE_OF_CONDUCT.md
|
50
|
+
- Gemfile
|
51
|
+
- LICENSE.txt
|
52
|
+
- README.md
|
53
|
+
- Rakefile
|
54
|
+
- active_objects.gemspec
|
55
|
+
- bin/console
|
56
|
+
- bin/setup
|
57
|
+
- lib/active_objects.rb
|
58
|
+
homepage: https://github.com/kamilsdz/active_objects
|
59
|
+
licenses:
|
60
|
+
- MIT
|
61
|
+
metadata: {}
|
62
|
+
post_install_message:
|
63
|
+
rdoc_options: []
|
64
|
+
require_paths:
|
65
|
+
- lib
|
66
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
67
|
+
requirements:
|
68
|
+
- - ">="
|
69
|
+
- !ruby/object:Gem::Version
|
70
|
+
version: '0'
|
71
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
requirements: []
|
77
|
+
rubyforge_project:
|
78
|
+
rubygems_version: 2.7.6
|
79
|
+
signing_key:
|
80
|
+
specification_version: 4
|
81
|
+
summary: Form objects for ActiveRecord models.
|
82
|
+
test_files: []
|