formally 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4024b86ffa06e7d2c4467601e0f3038f8649ca64
+  data.tar.gz: 511023d751f711b1c8e605a75b28cab2d301f4d9
+SHA512:
+  metadata.gz: 7bdfac920b4f1c8a06cb0bec054869abd62acedd4ffb480e724d6f385f69102b30e05654fae25930c051d5e642db072c8f223fe8e76bf0efa176545a49e085f4
+  data.tar.gz: 98b788cf129f170a8af41fd9ac77c7370b026906985efa0fba67b406d81ecc34c2c5fba9a7ff0a7c113de0e109f59429f98c2a289bf09f9ee2d34da4e80b4f0b

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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

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 jamesdabbs@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,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'manioc', path: '/data/src/manioc'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 James Dabbs
+
+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 @@
+# Formally
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/formally`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'formally'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formally
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/jamesdabbs/formally. 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,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 "formally"
+
+# 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/formally.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formally/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'formally'
+  spec.version       = Formally::VERSION
+  spec.authors       = ['James Dabbs']
+  spec.email         = ['jamesdabbs@gmail.com']
+
+  spec.summary       = %q{Form object helpers built on top of dry-validations}
+  spec.homepage      = 'https://github.com/jamesdabbs/formally'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  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_dependency 'dry-validation', '~> 0.11.1'
+
+  spec.add_development_dependency 'bundler',   '~> 1.14'
+  spec.add_development_dependency 'faker',     '~> 1.8' 
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~> 3.0'
+  spec.add_development_dependency 'pry',       '~> 0.11'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+end

data/lib/formally/class_methods.rb

@@ -0,0 +1,13 @@
+module Formally
+  module ClassMethods
+    attr_writer :formally
+
+    def formally *fields, &block
+      if block
+        @formally.schema = block
+        @formally.fields += fields
+      end
+      @formally
+    end
+  end
+end

data/lib/formally/config.rb

@@ -0,0 +1,50 @@
+module Formally
+  class Config < Manioc.mutable(:base, :transaction, :klass, :fields)
+    attr_accessor :schema
+    attr_reader :finalized_schema
+
+    def finalize
+      return if @finalized_schema
+
+      _schema     = schema
+      _fields     = fields || []
+      _predicates = Formally::PredicateFinder.call klass
+
+      @finalized_schema = Dry::Validation.Form base do
+        configure do
+          _fields.each do |name|
+            option name
+          end
+
+          option :_self
+
+          _predicates.each do |method|
+            if method.arity == 0
+              define_method method.name do
+                method.bind(_self).call
+              end
+            else
+              define_method method.name do |arg|
+                method.bind(_self).call arg
+              end
+            end
+          end
+
+          # class_exec(&_configure) if _configure
+        end
+
+        instance_exec(&_schema)
+      end
+
+      freeze
+    end
+
+    def new object
+      unless object.is_a? klass
+        raise ClassMismatch, "#{object.class} is not a #{@klass}"
+      end
+      finalize
+      State.new self, object
+    end
+  end
+end

data/lib/formally/errors.rb

@@ -0,0 +1,15 @@
+module Formally
+  Error = Class.new StandardError
+
+  ClassMismatch   = Class.new Error
+  SchemaUndefined = Class.new Error
+  Unfilled        = Class.new Error
+
+  Invalid = Class.new Error do
+    attr_accessor :form, :errors
+
+    def to_s
+      %|<Invalid(#{errors})>|
+    end
+  end
+end

data/lib/formally/overrides.rb

@@ -0,0 +1,42 @@
+module Formally
+  module Overrides
+    def initialize *args
+      super(*args)
+      @formally = self.class.formally.new self
+    end
+
+    def fill data={}
+      if data.respond_to?(:permit!)
+        # Assume ActionController::Parameters or similar
+        # The schema will handle whitelisting allowed attributes
+        data = data.permit!.to_h.deep_symbolize_keys
+      end
+
+      formally.call data
+
+      if formally.valid?
+        super formally.data
+      end
+
+      self
+    end
+
+    def save
+      return false unless formally.valid?
+      formally.transaction do
+        super
+      end
+      true
+    end
+
+    def save!
+      unless save
+        ex = Formally::Invalid.new
+        ex.form   = self
+        ex.errors = errors
+        raise ex
+      end
+      true
+    end
+  end
+end

data/lib/formally/predicate_finder.rb

@@ -0,0 +1,21 @@
+module Formally
+  module PredicateFinder
+    def self.all_method_names klass
+      (klass.instance_methods + klass.private_instance_methods).grep(/\?$/)
+    end
+
+    IGNORED_METHODS = all_method_names Object
+
+    def self.call klass
+      predicates = []
+      (all_method_names(klass) - IGNORED_METHODS).each do |name|
+        method = klass.instance_method name
+        predicates.push method if method.arity == 0 || method.arity == 1
+      end
+      Formally::Predicates.instance_methods.each do |name|
+        predicates.push Formally::Predicates.instance_method name
+      end
+      predicates
+    end
+  end
+end

data/lib/formally/railtie.rb

@@ -0,0 +1,9 @@
+module Formally
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do |app|
+      if defined? ApplicationRecord
+        Formally.config.transaction = ->(&block) { ApplicationRecord.transaction(&block) }
+      end
+    end
+  end
+end

data/lib/formally/state.rb

@@ -0,0 +1,35 @@
+module Formally
+  class State
+    def initialize config, object
+      @config, @object = config, object
+    end
+
+    def call data
+      injections = { _self: @object }
+      @config.fields.each do |name|
+        injections[name] = @object.send name
+      end
+
+      result  = @config.finalized_schema.with(injections).call data
+      @data   = result.output
+      @errors = result.errors
+      @filled = true
+    end
+
+    def data
+      @filled ? @data : raise(Formally::Unfilled)
+    end
+
+    def errors
+      @filled ? @errors : raise(Formally::Unfilled)
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def transaction &block
+      @config.transaction.call(&block)
+    end
+  end
+end

data/lib/formally/version.rb

@@ -0,0 +1,3 @@
+module Formally
+  VERSION = "0.1.0"
+end

data/lib/formally.rb

@@ -0,0 +1,44 @@
+require 'dry-validation'
+require 'manioc'
+
+require 'formally/errors'
+require 'formally/version'
+
+require 'formally/class_methods'
+require 'formally/config'
+require 'formally/overrides'
+require 'formally/predicate_finder'
+require 'formally/state'
+
+require 'formally/railtie' if defined? Rails::Railtie
+
+module Formally
+  module Predicates
+  end
+
+  class << self
+    attr_accessor :config
+
+    def predicates &block
+      Predicates.class_exec(&block)
+    end
+
+    def included base
+      base.extend  Formally::ClassMethods
+      base.prepend Formally::Overrides
+      base.formally = Formally.config.with(klass: base)
+    end
+  end
+
+  self.config = Formally::Config.new \
+    klass: nil, # will be completed at include time
+    base:  nil,
+    fields: [],
+    transaction: ->(&block) { block.call }
+
+  attr_reader :formally
+
+  extend Forwardable
+
+  def_delegators :@formally, :errors, :valid?
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: formally
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Dabbs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !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: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 
+email:
+- jamesdabbs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- formally.gemspec
+- lib/formally.rb
+- lib/formally/class_methods.rb
+- lib/formally/config.rb
+- lib/formally/errors.rb
+- lib/formally/overrides.rb
+- lib/formally/predicate_finder.rb
+- lib/formally/railtie.rb
+- lib/formally/state.rb
+- lib/formally/version.rb
+homepage: https://github.com/jamesdabbs/formally
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Form object helpers built on top of dry-validations
+test_files: []