formally 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1536db0a598695bcb4f89e17e2d4da26ec093965
-  data.tar.gz: 6ec27350face39a27b2ce03b3c289e5668e8cb1a
+  metadata.gz: 7cae6a8d45efd906fe3fee47da740ab7960a9d67
+  data.tar.gz: 951c117c80878ca2cdb9d1c8cd7191fdc3f12377
 SHA512:
-  metadata.gz: b0c3a07f5439a46900abbe48f8ee181b97ff0305f1e573557c0434800a498fa3d8dec8131bbeeaa4bb28dacc3ded988c52af43d62e39ae4ed72a346558c9a258
-  data.tar.gz: fef80e39a6aefe89a34b02e7b22a6b51ff3de41653f4b5e49c954ea4216b55d53f8e5fada23fef91907327cd000842b295b69ee6cbc73e14be56370cc8167c79
+  metadata.gz: 72de5baac3d75105f9d9993c130f633f12c0df688b5105fbcb65c6f501e5313ebcef759fd07b28b15d98ba51d7ae66bb9165b3d8bd75ab2f5d86ab916910b241
+  data.tar.gz: fe169bb5dc01808bf9c801e18e9cb6e0c9d129248ee6be587c38e5dd8903f6aa2897c3c54a3ede566d5be8acc32a0d9d97d29bbfc96ebe333f58838be35679d3

data/README.md

@@ -1,28 +1,58 @@
 # 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.
+A slim wrapper around `dry-validations` that makes it easier to write stateful form objects
 
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Add a schema to your class
 
-```ruby
-gem 'formally'
+```
+class UserUpdateForm
+  prepend Formally
+  formally do |f|
+    required(:name)     { str? }
+    required(:password) { eql? f.user.password }
+  end
+
+  attr_reader :user
+
+  def initialize user
+    @user = user
+  end
+
+  # This method will only ever be called with data validated by the
+  # schema above
+  def fill data
+    @user.name = data.fetch(:name)
+  end
+
+  # This method is wrapped in a (configurable) transaction
+  def save
+    # ...
+  end
+end
 ```
 
-And then execute:
+and use it
 
-    $ bundle
+```
+form = UserUpdateForm.new(user: ...)
+form.fill(name: 'James Dabbs', password: 'hunter2').save!
+```
 
-Or install it yourself as:
+## API
 
-    $ gem install formally
+Note that `Formally` does _prepend_ and so alters the following methods:
 
-## Usage
+* fill(data) - only ever called with valid data; always returns the form
+* save - wrapped in a transaction; returns true or false
+* save! - calls `save` or raises an error
+
+It also adds
 
-TODO: Write usage instructions here
+* formally - contains most form metadata
+* errors - to retrieve errors after `fill`ing
+* valid? - to check if the form was `fill`ed with valid data
 
 ## Development
 

data/lib/formally.rb

@@ -15,9 +15,8 @@ module Formally
   class << self
     attr_accessor :config
 
-    def included base
-      base.extend  Formally::ClassMethods
-      base.prepend Formally::Overrides
+    def prepended base
+      base.extend Formally::ClassMethods
       base.formally = Formally.config.with(klass: base)
     end
 
@@ -38,13 +37,49 @@ module Formally
     predicates: [],
     transaction: ->(&block) { block.call }
 
-  attr_writer :formally
-
-  def formally
-    @formally ||= self.class.formally.build
-  end
+  attr_reader :formally
 
   extend Forwardable
 
   def_delegators :@formally, :errors, :valid?
+
+  def initialize *args
+    super
+    @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
+    formally.callbacks(:after_commit).each(&:call)
+    true
+  end
+
+  def save!
+    unless save
+      ex = Formally::Invalid.new
+      ex.form   = self
+      ex.errors = errors
+      raise ex
+    end
+    true
+  end
 end

data/lib/formally/class_methods.rb

@@ -8,11 +8,5 @@ module Formally
       end
       @formally
     end
-
-    def build **opts
-      new(**opts).tap do |instance|
-        instance.formally = formally.build(**opts)
-      end
-    end
   end
 end

data/lib/formally/config.rb

@@ -2,19 +2,19 @@ module Formally
   class Config < Manioc.mutable(:base, :predicates, :transaction, :klass)
     attr_accessor :schema
 
-    def build **opts
+    def new instance
       Formally::State.new \
-        schema:      schema_for(**opts),
+        schema:      schema_for(instance),
         transaction: transaction
     end
 
     private
 
-    def schema_for **opts
-      if opts.none? && schema.arity.zero?
-        @_cached_schema ||= build_schema
+    def schema_for instance
+      if schema.arity.zero?
+        @_cached_schema ||= build_schema instance
       else
-        build_schema opts
+        build_schema instance
       end
     end
 

data/lib/formally/overrides.rb

@@ -1,38 +1,4 @@
 module Formally
   module Overrides
-    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
-      formally.callbacks(:after_commit).each(&:call)
-      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/version.rb

@@ -1,3 +1,3 @@
 module Formally
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formally
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - James Dabbs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation