rails_form_object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e613895c81a05537b0b08ecb42cf38b6d0615a85
+  data.tar.gz: 324ecc538cf1af2f024d50fcbf382f6fde0455aa
+SHA512:
+  metadata.gz: ad7f8f625196f3a3cc5ab944c2e5e27a2e92195dd7b1156eceef7733b08e13db7f225f8cf334454096444005b12133d7fb55a7fb60f1b8c751ba7546a9c92483
+  data.tar.gz: 6c8035ea428dc9c6b8b2e4dc70f0480f925e0697d05fbe9170be67572d90f63a58097e218129bbcc110b85f6624151b756250e039bac35c417eff38c45862dd8

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+      - 'bin/**'
+      - 'vendor/**/*'
+      - 'example/*'
+      - 'rails_form_object.gemspec'
+Documentation:
+   Enabled: false
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at galaspiotrek@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_form_object.gemspec
+gemspec
+
+gem 'activemodel'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Piotr
+
+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,110 @@
+# RailsFormObject
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_form_object'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_form_object
+    
+## Intention
+    
+It allow you to move validations away from models. It get `hash` of params, or `strong parameters` as initializer instead of `model instance` and then run `active_model` validations on it
+
+Gem allow you to:
+  - validates `hashes` or `strong_parameters`
+  - use standard validations from `active_model`
+  
+Gem do not allow you to:
+  - validates models directly, because of simplicity
+  - save model, because of single responsibility principle
+
+## Usage
+
+To define form_object you need to specify list of attributes to validation, and then define standard `active_model` validations
+
+```ruby
+ class UserEditFriendData < RailsFormObject::Base
+   attributes :frist_name, :last_name
+   validates :first_name, :last_name, presence: true
+   validate :custom_validation
+     
+   def custom_validation
+     # custom validator here
+   end
+ end
+```
+
+Example usage of `UserEditOwnData` in controller
+ 
+```ruby
+  class FriendsController < ActionController::Base
+    def new 
+      @friend_form = UserEditFriendData.new
+    end
+    
+    def edit
+       friend = Friend.find(params[:id])
+       @friend_form = UserEditFriendData.new(friend.attributes)
+    end
+    
+    def create
+      @friend_form = UserEditFriendData.new(friend_params)
+      if @friend_form.valid?
+         friend = Friend.new(friend_params)
+         friend.save(validation: false)
+         redirect_to friend
+      else
+         render :new
+      end
+    end
+    
+    def update
+      @friend_form = UserEditFriendData.new(friend_params)
+      if @friend_form.valid?
+         friend = Friend.find(params[:id])
+         friend.assign_attributes(friend_params)
+         friend.save(validation: false)
+         redirect_to friend
+      else
+         render :edit
+      end
+    end
+    
+    def friend_params
+      params.require(:user_edit_friend_data).permit(:first_name, :last_name)
+    end
+  end
+``` 
+
+## TODO
+ PR are welcome
+ 
+ - Add support for nested attributes and nested form
+ - Add optional uniqueness validator
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. Then run `rubocop` You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/piotr-galas/rails_form_object. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rails_form_object'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_form_object/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module RailsFormObject
+  AttributesMustBeDefined = Class.new(StandardError)
+  class Base
+    include ActiveModel::Model
+
+    def self.attributes(*attr)
+      attr_accessor(*attr)
+      define_method(:stored_attributes) { attr }
+    end
+
+    def filtered_attributes(attributes)
+      raise AttributesMustBeDefined unless respond_to? :stored_attributes
+      attributes.select { |key, _value| stored_attributes.include?(key.to_sym) }
+    end
+
+    def initialize(attributes)
+      super(filtered_attributes(attributes))
+    end
+  end
+end

data/lib/rails_form_object/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsFormObject
+  VERSION = '0.1.0'
+end

data/lib/rails_form_object.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rails_form_object/version'
+require 'rails_form_object/base'

data/rails_form_object.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_form_object/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_form_object'
+  spec.version       = RailsFormObject::VERSION
+  spec.authors       = ['Piotr']
+  spec.email         = ['galaspiotrek@gmail.com']
+
+  spec.summary       = 'It allows to create very simple form object behave like active model'
+  spec.description   = 'If you want to decouple validations from model it would be probably the easiest solution'
+  spec.homepage      = 'https://github.com/piotr-galas/rails_form_object'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'activemodel'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rails_form_object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: If you want to decouple validations from model it would be probably the
+  easiest solution
+email:
+- galaspiotrek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_form_object.rb
+- lib/rails_form_object/base.rb
+- lib/rails_form_object/version.rb
+- rails_form_object.gemspec
+homepage: https://github.com/piotr-galas/rails_form_object
+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.6.11
+signing_key: 
+specification_version: 4
+summary: It allows to create very simple form object behave like active model
+test_files: []