formally 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 4024b86ffa06e7d2c4467601e0f3038f8649ca64
4
+ data.tar.gz: 511023d751f711b1c8e605a75b28cab2d301f4d9
5
+ SHA512:
6
+ metadata.gz: 7bdfac920b4f1c8a06cb0bec054869abd62acedd4ffb480e724d6f385f69102b30e05654fae25930c051d5e642db072c8f223fe8e76bf0efa176545a49e085f4
7
+ data.tar.gz: 98b788cf129f170a8af41fd9ac77c7370b026906985efa0fba67b406d81ecc34c2c5fba9a7ff0a7c113de0e109f59429f98c2a289bf09f9ee2d34da4e80b4f0b
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.0
5
+ before_install: gem install bundler -v 1.14.6
@@ -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 jamesdabbs@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
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ gem 'manioc', path: '/data/src/manioc'
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 James Dabbs
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,41 @@
1
+ # Formally
2
+
3
+ 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.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'formally'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install formally
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ 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.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "formally"
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,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/formally.gemspec ADDED
@@ -0,0 +1,33 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'formally/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'formally'
8
+ spec.version = Formally::VERSION
9
+ spec.authors = ['James Dabbs']
10
+ spec.email = ['jamesdabbs@gmail.com']
11
+
12
+ spec.summary = %q{Form object helpers built on top of dry-validations}
13
+ spec.homepage = 'https://github.com/jamesdabbs/formally'
14
+ spec.license = 'MIT'
15
+
16
+ spec.metadata['allowed_push_host'] = 'https://rubygems.org'
17
+
18
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
19
+ f.match(%r{^(test|spec|features)/})
20
+ end
21
+ spec.bindir = 'exe'
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ['lib']
24
+
25
+ spec.add_dependency 'dry-validation', '~> 0.11.1'
26
+
27
+ spec.add_development_dependency 'bundler', '~> 1.14'
28
+ spec.add_development_dependency 'faker', '~> 1.8'
29
+ spec.add_development_dependency 'rake', '~> 10.0'
30
+ spec.add_development_dependency 'rspec', '~> 3.0'
31
+ spec.add_development_dependency 'pry', '~> 0.11'
32
+ spec.add_development_dependency 'simplecov', '~> 0.15'
33
+ end
@@ -0,0 +1,13 @@
1
+ module Formally
2
+ module ClassMethods
3
+ attr_writer :formally
4
+
5
+ def formally *fields, &block
6
+ if block
7
+ @formally.schema = block
8
+ @formally.fields += fields
9
+ end
10
+ @formally
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,50 @@
1
+ module Formally
2
+ class Config < Manioc.mutable(:base, :transaction, :klass, :fields)
3
+ attr_accessor :schema
4
+ attr_reader :finalized_schema
5
+
6
+ def finalize
7
+ return if @finalized_schema
8
+
9
+ _schema = schema
10
+ _fields = fields || []
11
+ _predicates = Formally::PredicateFinder.call klass
12
+
13
+ @finalized_schema = Dry::Validation.Form base do
14
+ configure do
15
+ _fields.each do |name|
16
+ option name
17
+ end
18
+
19
+ option :_self
20
+
21
+ _predicates.each do |method|
22
+ if method.arity == 0
23
+ define_method method.name do
24
+ method.bind(_self).call
25
+ end
26
+ else
27
+ define_method method.name do |arg|
28
+ method.bind(_self).call arg
29
+ end
30
+ end
31
+ end
32
+
33
+ # class_exec(&_configure) if _configure
34
+ end
35
+
36
+ instance_exec(&_schema)
37
+ end
38
+
39
+ freeze
40
+ end
41
+
42
+ def new object
43
+ unless object.is_a? klass
44
+ raise ClassMismatch, "#{object.class} is not a #{@klass}"
45
+ end
46
+ finalize
47
+ State.new self, object
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,15 @@
1
+ module Formally
2
+ Error = Class.new StandardError
3
+
4
+ ClassMismatch = Class.new Error
5
+ SchemaUndefined = Class.new Error
6
+ Unfilled = Class.new Error
7
+
8
+ Invalid = Class.new Error do
9
+ attr_accessor :form, :errors
10
+
11
+ def to_s
12
+ %|<Invalid(#{errors})>|
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,42 @@
1
+ module Formally
2
+ module Overrides
3
+ def initialize *args
4
+ super(*args)
5
+ @formally = self.class.formally.new self
6
+ end
7
+
8
+ def fill data={}
9
+ if data.respond_to?(:permit!)
10
+ # Assume ActionController::Parameters or similar
11
+ # The schema will handle whitelisting allowed attributes
12
+ data = data.permit!.to_h.deep_symbolize_keys
13
+ end
14
+
15
+ formally.call data
16
+
17
+ if formally.valid?
18
+ super formally.data
19
+ end
20
+
21
+ self
22
+ end
23
+
24
+ def save
25
+ return false unless formally.valid?
26
+ formally.transaction do
27
+ super
28
+ end
29
+ true
30
+ end
31
+
32
+ def save!
33
+ unless save
34
+ ex = Formally::Invalid.new
35
+ ex.form = self
36
+ ex.errors = errors
37
+ raise ex
38
+ end
39
+ true
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,21 @@
1
+ module Formally
2
+ module PredicateFinder
3
+ def self.all_method_names klass
4
+ (klass.instance_methods + klass.private_instance_methods).grep(/\?$/)
5
+ end
6
+
7
+ IGNORED_METHODS = all_method_names Object
8
+
9
+ def self.call klass
10
+ predicates = []
11
+ (all_method_names(klass) - IGNORED_METHODS).each do |name|
12
+ method = klass.instance_method name
13
+ predicates.push method if method.arity == 0 || method.arity == 1
14
+ end
15
+ Formally::Predicates.instance_methods.each do |name|
16
+ predicates.push Formally::Predicates.instance_method name
17
+ end
18
+ predicates
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,9 @@
1
+ module Formally
2
+ class Railtie < ::Rails::Railtie
3
+ config.after_initialize do |app|
4
+ if defined? ApplicationRecord
5
+ Formally.config.transaction = ->(&block) { ApplicationRecord.transaction(&block) }
6
+ end
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,35 @@
1
+ module Formally
2
+ class State
3
+ def initialize config, object
4
+ @config, @object = config, object
5
+ end
6
+
7
+ def call data
8
+ injections = { _self: @object }
9
+ @config.fields.each do |name|
10
+ injections[name] = @object.send name
11
+ end
12
+
13
+ result = @config.finalized_schema.with(injections).call data
14
+ @data = result.output
15
+ @errors = result.errors
16
+ @filled = true
17
+ end
18
+
19
+ def data
20
+ @filled ? @data : raise(Formally::Unfilled)
21
+ end
22
+
23
+ def errors
24
+ @filled ? @errors : raise(Formally::Unfilled)
25
+ end
26
+
27
+ def valid?
28
+ errors.empty?
29
+ end
30
+
31
+ def transaction &block
32
+ @config.transaction.call(&block)
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,3 @@
1
+ module Formally
2
+ VERSION = "0.1.0"
3
+ end
data/lib/formally.rb ADDED
@@ -0,0 +1,44 @@
1
+ require 'dry-validation'
2
+ require 'manioc'
3
+
4
+ require 'formally/errors'
5
+ require 'formally/version'
6
+
7
+ require 'formally/class_methods'
8
+ require 'formally/config'
9
+ require 'formally/overrides'
10
+ require 'formally/predicate_finder'
11
+ require 'formally/state'
12
+
13
+ require 'formally/railtie' if defined? Rails::Railtie
14
+
15
+ module Formally
16
+ module Predicates
17
+ end
18
+
19
+ class << self
20
+ attr_accessor :config
21
+
22
+ def predicates &block
23
+ Predicates.class_exec(&block)
24
+ end
25
+
26
+ def included base
27
+ base.extend Formally::ClassMethods
28
+ base.prepend Formally::Overrides
29
+ base.formally = Formally.config.with(klass: base)
30
+ end
31
+ end
32
+
33
+ self.config = Formally::Config.new \
34
+ klass: nil, # will be completed at include time
35
+ base: nil,
36
+ fields: [],
37
+ transaction: ->(&block) { block.call }
38
+
39
+ attr_reader :formally
40
+
41
+ extend Forwardable
42
+
43
+ def_delegators :@formally, :errors, :valid?
44
+ end
metadata ADDED
@@ -0,0 +1,163 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: formally
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - James Dabbs
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-11-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: dry-validation
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.11.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.11.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.14'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.14'
41
+ - !ruby/object:Gem::Dependency
42
+ name: faker
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.8'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.8'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: pry
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '0.11'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '0.11'
97
+ - !ruby/object:Gem::Dependency
98
+ name: simplecov
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.15'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.15'
111
+ description:
112
+ email:
113
+ - jamesdabbs@gmail.com
114
+ executables: []
115
+ extensions: []
116
+ extra_rdoc_files: []
117
+ files:
118
+ - ".gitignore"
119
+ - ".rspec"
120
+ - ".travis.yml"
121
+ - CODE_OF_CONDUCT.md
122
+ - Gemfile
123
+ - LICENSE.txt
124
+ - README.md
125
+ - Rakefile
126
+ - bin/console
127
+ - bin/setup
128
+ - formally.gemspec
129
+ - lib/formally.rb
130
+ - lib/formally/class_methods.rb
131
+ - lib/formally/config.rb
132
+ - lib/formally/errors.rb
133
+ - lib/formally/overrides.rb
134
+ - lib/formally/predicate_finder.rb
135
+ - lib/formally/railtie.rb
136
+ - lib/formally/state.rb
137
+ - lib/formally/version.rb
138
+ homepage: https://github.com/jamesdabbs/formally
139
+ licenses:
140
+ - MIT
141
+ metadata:
142
+ allowed_push_host: https://rubygems.org
143
+ post_install_message:
144
+ rdoc_options: []
145
+ require_paths:
146
+ - lib
147
+ required_ruby_version: !ruby/object:Gem::Requirement
148
+ requirements:
149
+ - - ">="
150
+ - !ruby/object:Gem::Version
151
+ version: '0'
152
+ required_rubygems_version: !ruby/object:Gem::Requirement
153
+ requirements:
154
+ - - ">="
155
+ - !ruby/object:Gem::Version
156
+ version: '0'
157
+ requirements: []
158
+ rubyforge_project:
159
+ rubygems_version: 2.6.8
160
+ signing_key:
161
+ specification_version: 4
162
+ summary: Form object helpers built on top of dry-validations
163
+ test_files: []