writ 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67c0b4c57a61a29b4036ee1f1e7f216d537849e2
+  data.tar.gz: 3c38c672cfbf783f3c3351de5cb2f73af181797e
+SHA512:
+  metadata.gz: 08b642aec1d49003c8d4aa10b826b651eb1e33c35dd121e631417d6bcf0e0142d8ad7f9f63a67f370918073db6559d307504e790046d7d56dc9e220fac47fb1a
+  data.tar.gz: e48fba03b082eb90965d6f812cc675096ea4dc87ac09dc7c50cc2ff3a53ce101175992a7c56f153bc33d0ca9eebbfd3ea504709330f098104c5e7fe9d14f484c

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Nicolas Sanguinetti <hi@nicolassanguinetti.info>
+
+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,61 @@
+# Writ: A minimal command pattern implementation
+
+> **writ**, _noun_:<br>
+> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a form of written command in the name of a court or other legal authority to act, or abstain from acting, in some way.
+
+`Writ` is a minimal [command pattern][pattern] implementation, including input validation, built on top of [Scrivener][scrivener].
+
+[pattern]: http://wiki.c2.com/?CommandPattern
+[scrivener]: https://github.com/soveran/scrivener
+
+# Example
+
+``` ruby
+# Define your commands
+class LogIn < Writ
+  attr_accessor :email
+  attr_accessor :password
+
+  def validate
+    assert_email :email
+    assert_present :password
+  end
+
+  def run
+    user = User.authenticate(email, password)
+    assert user, [:email, :not_valid]
+  end
+end
+
+# And use them
+outcome = LogIn.run(req.params)
+
+if outcome.success?
+  session[:user_id] = outcome.value.id
+else
+  outcome.input.password = nil # Don't leak it when rendering the form again
+  render "auth/sign_in", errors: outcome.errors, form: outcome.input
+end
+```
+
+## Install
+
+    gem install writ
+
+## Validations
+
+As with [scrivener][], you should define a `validate` method that defines all validations for the user input. You're also welcome to use validations inside of `run`, when an error can come from the process itself. The example above, where the email/password combination yields no user, is a good example. Another example would be having to make an API call that returns an error.
+
+Take a look at the default [validations](https://github.com/soveran/scrivener#assertions) that come from scrivener, or feel free to define custom ones to suit your domain.
+
+## Why
+
+When using [scrivener][], I tend to add a `run` method to the objects to alter state based on user input alongside the validations. Some people like calling these objects "services", "use cases", "commands", or "interactions".
+
+I find this useful to decouple complex actions from the actors involved in them, and to keep models "thin" by only caring about expressing the domain without burdening themselves with expressing how users can interact with the domain, or with concepts like validation and authorization.
+
+After using this pattern in several production projects, I figured it might as well live in a gem I can reuse instead of copy-pasting code around.
+
+## License
+
+This project is shared under the MIT license. See the attached [LICENSE](./LICENSE) file for details.

data/lib/writ.rb

@@ -0,0 +1,58 @@
+require "scrivener"
+
+class Writ < Scrivener
+  # Public: Run the command with the provided input. Any arguments will be
+  # forwarded to `Writ#new`.
+  #
+  # Returns a Writ::Outcome.
+  def self.run(*args, &block)
+    new(*args, &block).run!
+  end
+
+  # Internal: Runs your business logic, and assigns the return value of this
+  # method as the Outcome's `#value`.
+  #
+  # Returns an Object.
+  def run
+    fail NotImplementedError
+  end
+
+  # Internal: Perform validations, run the business logic, and generate the
+  # outcome to return.
+  #
+  # Returns a Writ::Outcome.
+  def run!
+    result = run if valid?
+    Outcome.new(result, self)
+  end
+
+  class Outcome
+    # Public: Get the return value of your Writ.
+    attr_reader :value
+
+    # Public: Get the Writ object, with the user input as accessors.
+    attr_reader :input
+
+    # Public: Get the errors Hash generated by running Writ.run. This will be an
+    # empty Hash if no errors were returned.
+    attr_reader :errors
+
+    # Public: Initialize the outcome.
+    #
+    # value - The return value from Writ.run
+    # writ  - The Writ instance.
+    def initialize(value, writ)
+      @value = value
+      @input = writ
+      @errors = writ.errors
+    end
+
+    # Public: Whether the Writ performed successfully or not (i.e. no errors are
+    # present.)
+    #
+    # Returns Boolean.
+    def success?
+      errors.empty?
+    end
+  end
+end

data/lib/writ/version.rb

@@ -0,0 +1,3 @@
+class Writ
+  VERSION = "1.0.0.rc1".freeze
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: writ
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Nicolas Sanguinetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scrivener
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Tiny implementation of the command pattern, including input validation,
+  using Scrivener.
+email:
+- contacto@nicolassanguinetti.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/writ.rb
+- lib/writ/version.rb
+homepage: http://github.com/foca/writ
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Minimal implementation of the command pattern.
+test_files: []