formify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6986f5a092a5b5c13abbd8daeff88ea4571d69b647db4684843ef1107704434
+  data.tar.gz: 401a723a94bd78ef45c677f1b32435b037ce76785f37cfad18ddb731c1d086f7
+SHA512:
+  metadata.gz: dae0ce0a184c7793fa3880b14a956ea9a4c4fcde301d251a6ef7e5220d9939a076480537eb20150cd6df100f958cb8971a51c3f2dd91234aaec0781f1e2acc5d
+  data.tar.gz: 5cafd37279bedd6aa9ae96e37e286de0be761b1c5f2a65e798e00ff1ad1aac173e41616a64033a3ad0b2f334278692e04be4fa3f10a1db7e2bb46069288edb36

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+Initial release.

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 ryanwjackson@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in formify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    formify (0.1.0)
+      resonad
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    resonad (1.2.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  formify!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ryan Jackson
+
+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,41 @@
+# Formify
+
+Formify gives you scaffolding for quickly adding robust forms to your application.  Formify also includes rspec testing helpers, making it easy to validate forms.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'formify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formify
+
+## Usage
+
+Once installed, use `include Formify::Form` into any class to give it the form structure.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/ryanwjackson/formify. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Formify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ryanwjackson/formify/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+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 "formify"
+
+# 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/formify.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'formify'
+  spec.version       = Formify::VERSION
+  spec.authors       = ['Ryan Jackson']
+  spec.email         = ['ryanwjackson@gmail.com']
+
+  spec.summary       = 'Formify gives structure to using form objects in a Rails project.'
+  spec.description   = 'Formify acts as an abstract class, allowing you to easily create robust form objects and test them using rspec.'
+  spec.homepage      = 'https://www.github.com/ryanwjackson/formify'
+  spec.license       = 'MIT'
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'rubygems.org'
+  #   spec.metadata['homepage_uri'] = spec.homepage
+  #   spec.metadata['source_code_uri'] = spec.homepage
+  #   spec.metadata['changelog_uri'] = 'https://github.com/ryanwjackson/formify/blob/master/CHANGELOG.md'
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'resonad'
+end

data/lib/formify/form.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Formify
+  module Form
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveModel::Model
+      include ActiveModel::Validations
+      include ActiveModel::Validations::Callbacks
+
+      def t(*args, **keywords)
+        I18n.t(*args, **keywords)
+      end
+
+      def validate_or_fail(*instances)
+        unless valid?
+          return Resonad.Failure(
+            Forms::Errors::ValidationError.new(form: self)
+          )
+        end
+
+        if instances.present?
+          instances.each do |instance|
+            next if instance.valid?
+
+            return Resonad.Failure(
+              Forms::Errors::ValidationError.new(form: self, message: instance.full_messages.first)
+            )
+          end
+        end
+
+        Resonad.Success
+      end
+
+      def return_self
+        Resonad.Success(self)
+      end
+
+      def translation_data
+        {}
+      end
+
+      def translation_success
+        split_name = self.class.name.split('::')
+        split_name.shift
+        action = split_name.pop.underscore
+        key = split_name.map(&:underscore).push(action).push(:success).join('.')
+        return t(key) if I18n.exists?(key, translation_data)
+      end
+
+      def with_advisory_lock(*keys, **args)
+        key = keys.map do |k|
+          if k.is_a?(String)
+            k
+          else
+            k.try(:id)
+          end
+        end.join('/')
+        ActiveRecord::Base.with_advisory_lock(key, **args) { yield }
+      end
+
+      def with_advisory_lock_transaction(*keys)
+        with_advisory_lock_transaction_result = Resonad.Failure
+
+        with_advisory_lock(*keys, transaction: true) do
+          ActiveRecord::Base.transaction do
+            with_advisory_lock_transaction_result = begin
+              yield
+            end
+
+            raise ActiveRecord::Rollback if with_advisory_lock_transaction_result.failure?
+          end
+        end
+
+        with_advisory_lock_transaction_result
+      end
+
+      def params
+        self.class.params
+      end
+    end
+
+    class_methods do
+      def attr_accessor(*attrs)
+        @class_params ||= []
+        @class_params.concat(attrs)
+        super(*attrs)
+      end
+
+      def delegate_accessor(*args, **keywords)
+        delegate(
+          *args.map { |arg| [arg, "#{arg}="] }.flatten,
+          **keywords
+        )
+      end
+
+      def params
+        @params ||= @class_params.reject { |e| %i[validation_context].include?(e) }
+      end
+    end
+  end
+end

data/lib/formify/spec_helpers.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Formify
+  module SpecHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      let(:form) { described_class }
+      let(:initialized_form) { initialize_form }
+      let(:attributes_override) { {} }
+      let(:attributes_to_pass) { attributes.merge(attributes_override) }
+
+      let(:result) { do_result }
+
+      let(:value) { do_value }
+
+      let(:error) { result.error }
+      let(:error_message) { result.error.message }
+
+      def do_result
+        initialized_form.save
+      end
+
+      def do_value
+        result.value
+      end
+
+      def initialize_form
+        form.new(attributes_to_pass)
+      end
+
+      # Common Expectation Helpers
+
+      def expect_error_message(message)
+        expect(error_message).to include(message)
+      end
+
+      def expect_error_with_attribute(attribute)
+        expect(error.attribute.try(:to_sym)).to eq(attribute.to_sym)
+      end
+
+      def expect_error_with_attribute_value(attribute, value)
+        initialized_form.send("#{attribute}=", value)
+        expect_error_with_attribute(attribute)
+      end
+
+      def expect_error_with_missing_attribute(attribute)
+        raise 'No attribute' unless attributes.key?(attribute)
+
+        attributes_to_pass.delete(attribute)
+        expect_error_with_attribute(attribute)
+      end
+
+      def expect_invalid(*args, **keywords)
+        expect_not_valid(*args, **keywords)
+      end
+
+      def expect_not_valid(attribute: nil, message: nil)
+        expect_error_with_attribute(attribute) if attribute.present?
+        expect_error_message(message) if message.present?
+
+        expect(initialized_form).not_to be_valid
+      end
+
+      def expect_valid
+        expect(initialized_form).to be_valid
+      end
+
+      def expect_valid_with_attribute_value(attribute, value)
+        initialized_form.send("#{attribute}=", value)
+        expect_valid
+      end
+    end
+  end
+end

data/lib/formify/version.rb

@@ -0,0 +1,3 @@
+module Formify
+  VERSION = '0.1.0'.freeze
+end

data/lib/formify.rb

@@ -0,0 +1,6 @@
+require "formify/version"
+require "resonad"
+
+module Formify
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: formify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Jackson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: 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: resonad
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Formify acts as an abstract class, allowing you to easily create robust
+  form objects and test them using rspec.
+email:
+- ryanwjackson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- formify.gemspec
+- lib/formify.rb
+- lib/formify/form.rb
+- lib/formify/spec_helpers.rb
+- lib/formify/version.rb
+homepage: https://www.github.com/ryanwjackson/formify
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Formify gives structure to using form objects in a Rails project.
+test_files: []