moist-action 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ca7a3cb8001d0746c9934e3879b29b5593658d5
+  data.tar.gz: 3b8a4888f4ed289f8722658af446400094c15da2
+SHA512:
+  metadata.gz: 26c64c8a5c3f9c93ba8e50a3739d7da50cba9417eb9463b11d4395c4ad6b436d318821d542b73c5ee9b9e1cc7ce467d7b21b9ab720b802d18bb43bf9d94a9c9e
+  data.tar.gz: 2b97a3ab4a86f7f04a913c0d6853dbb60d1ed3d8226c6ffa840b82f920c9167fc12ea44d3d231fe639c22092c6095daa01d93baaa680c4e72f7f61680916f7c6

data/lib/moist/action.rb

@@ -0,0 +1,73 @@
+require 'dry/validation'
+require 'fear/either'
+require 'moist/action/version'
+
+module Moist
+  # This module provides validation logic for controller actions.
+  # @example
+  #   class RegisterUser
+  #     include Moist::Action
+  #
+  #     params do
+  #       required(:name).filled(:str?)
+  #       required(:email).filled(format?: EMAIL_REGEX)
+  #       required(:age).maybe(:int?)
+  #     end
+  #
+  #     def perform(params)
+  #       User.create(params)
+  #     end
+  #
+  module Action
+    include Fear::Either::Mixin
+
+    module Params # rubocop:disable Style/Documentation
+      EMPTY_FORM = Dry::Validation.Form()
+
+      # Specify params validator
+      # @example
+      #   class ChangeUsername
+      #     include Moist::Action
+      #
+      #     params do
+      #       required(:username).filled?(:str?)
+      #     end
+      #   end
+      #
+      # @see http://dry-rb.org/gems/dry-validation/forms/
+      def params(&block)
+        if block_given?
+          @params = Dry::Validation.Form(&block)
+        else
+          @params || EMPTY_FORM
+        end
+      end
+    end
+
+    class << self
+      def included(base)
+        base.extend(Params)
+      end
+    end
+
+    # @param params [{Symbol => any}]
+    # @return [Fear::Right<any>, Fear::Left<{Symbol => <String>}>] returns +Fear::Right+ in
+    #   case of successful validation or +Fear::Left+ in case of error.
+    #
+    def call(params)
+      validation_result = self.class.params.(params)
+      if validation_result.success?
+        Right(perform(validation_result.output))
+      else
+        Left(validation_result.messages)
+      end
+    end
+
+    # Template method to be overridden by an Action
+    # @param _params [{Symbol => any}]
+    # @return [<any>]
+    def perform(_params)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/moist/action/version.rb

@@ -0,0 +1,5 @@
+module Moist
+  module Action
+    VERSION = '0.2.0'.freeze
+  end
+end

data/spec/moist/action_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'fear/rspec'
+require 'spec_helper'
+
+RSpec.describe Moist::Action do
+  context 'actions without defined params' do
+    subject { action.new.(foo: 'bar') }
+
+    let(:action) do
+      Class.new do
+        include Moist::Action
+
+        def perform(params)
+          params
+        end
+      end
+    end
+
+    it 'strip out all given params' do
+      is_expected.to be_right_of({})
+    end
+  end
+
+  context 'actions with required params' do
+    let(:action) do
+      Class.new do
+        include Moist::Action
+
+        params do
+          required(:name).filled(:str?)
+        end
+
+        def perform(params)
+          params
+        end
+      end
+    end
+
+    context 'required param given' do
+      subject { action.new.(name: 'Carl', surname: 'Lazlo') }
+
+      it 'keep this param and strip out other params' do
+        is_expected.to be_right_of(name: 'Carl')
+      end
+    end
+
+    context 'required param is invalid' do
+      subject { action.new.(name: '') }
+
+      it 'keep this param and strip out other params' do
+        is_expected.to be_left_of(name: ['must be filled'])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+require 'moist/action'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: moist-action
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Tema Bolshakov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: fear-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !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: fear
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Better controller actions
+email:
+- either.free@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/moist/action.rb
+- lib/moist/action/version.rb
+- spec/moist/action_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/moist-rb/action
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Better controller actions
+test_files:
+- spec/spec_helper.rb
+- spec/moist/action_spec.rb