creed 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ec85575cece4defb4fb57ca8521494d4c350aef99730269747872e17aa66c1
-  data.tar.gz: 8c15a9cfd8f219140efec5a0d0b82ca6d92dd89020898f065f29ef1ed9ce7365
+  metadata.gz: 775ab09abd887ecb445430e67b88c84cb466bcb7f3c427c3b21b24700661d67a
+  data.tar.gz: 2bb759c10b91d54a85ba38682ca3d036d334abd91d31d2ab6b6230d7d0bdec15
 SHA512:
-  metadata.gz: '085d2028e4f104d642cda0490d94b6d91d100bd02f1f179fb9124592529a426c593b200d144c945bea4bb7c109b2650e6e822f486bbb5f75d9c78af37472876b'
-  data.tar.gz: bd7c1d695f8f63cd5db1b1e7e586bdc35f56a9fa6983448ab8b67669e8ae33b1201fa1ac4a778fc1843ffc201c065c76b99488980ca5ab91a9bc29722ebeb221
+  metadata.gz: f7f58b2fa021cd1b674bc0b5cff7aaf39ee1d61f6e04f2baef31348d55def3b9b5dbc6e508a6bf5f9fa9963fd5a8d485191c4b1ea14a4abd418a23709a8e69ad
+  data.tar.gz: 3775609dfb85c9d6f617344fc98f6e15dfb45463175c3228c999fe9cf7f7cc1c9645358ecff1c69b3719f731ad9023d5cbb95ac26965e5feacc32259d0f3e1dd

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    creed (0.1.0)
+    creed (0.4.1)
       actionpack (>= 6.0)
       dry-initializer
+      dry-initializer-rails
       dry-types
       railties (>= 6.0)
       responders
@@ -11,115 +12,189 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-      rack (~> 2.0, >= 2.0.8)
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.1)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ansi (1.5.0)
-    ast (2.4.0)
+    ast (2.4.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
-    dry-configurable (0.11.3)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
-    dry-container (0.7.2)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-inflector (0.2.0)
-    dry-initializer (3.0.3)
-    dry-logic (1.0.6)
+    dry-inflector (0.2.1)
+    dry-initializer (3.0.4)
+    dry-initializer-rails (3.1.1)
+      dry-initializer (>= 2.4, < 4)
+      rails (> 3.0)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-types (1.3.1)
+      dry-core (~> 0.5, >= 0.5)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    erubi (1.9.0)
-    i18n (1.8.2)
+    erubi (1.10.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    loofah (2.4.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    minitest-focus (1.1.2)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.0.3)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    minitest-focus (1.2.1)
       minitest (>= 4, < 6)
-    minitest-reporters (1.4.2)
+    minitest-reporters (1.4.3)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mocha (1.11.2)
-    nokogiri (1.10.8)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    rack (2.2.2)
+    mocha (1.12.0)
+    nio4r (2.5.8)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
+      sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    responders (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    responders (3.0.1)
       actionpack (>= 5.0)
       railties (>= 5.0)
-    rexml (3.2.4)
-    rubocop (0.80.0)
-      jaro_winkler (~> 1.5.1)
+    rexml (3.2.5)
+    rubocop (1.12.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.2.2)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -136,4 +211,4 @@ DEPENDENCIES
   rubocop-performance
 
 BUNDLED WITH
-   2.1.4
+   2.2.25

data/README.md

@@ -20,14 +20,17 @@ Or install it yourself as:
 
 ## Usage
 
-Create your Command classes in `app/commands`, extending `Creed::Command`, and implementing a `perform` method:
+Create your Command classes in `app/commands`, extending `Creed::Command`, and implementing a `perform` method. Optionally defining params and/or options that can be passed when performing the command. Unknown arguments will raise an exception.
 
 ```ruby
 class CreateUser < Creed::Command
-  # Define types and/or validations.
+  # Define types and/or validations. See https://github.com/dry-rb/dry-initializer.
   param :user_params, Creed::Types.Instance(ActionController::Parameters)
+  option :validate, default: true
 
-  def perform
+  # #perform has access to all options and params and named attributes. You can also pass it a
+  # block.
+  def perform(&block)
     # Do something here...
   end
 end
@@ -38,7 +41,7 @@ Then in your controller (or anywhere):
 ```ruby
 class UserController < ApplicationController
   def create
-    CreateUser.perform(user_params)
+    CreateUser.perform(user_params, validate: false)
   end
 end
 ```

data/creed.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Joel Moss']
   spec.email         = ['joel@developwithstyle.com']
 
-  spec.summary       = 'Command pattern or Rails'
+  spec.summary       = 'Command pattern for Rails'
   spec.homepage      = 'https://github.com/joelmoss/creed'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'actionpack', '>= 6.0'
   spec.add_dependency 'dry-initializer'
+  spec.add_dependency 'dry-initializer-rails'
   spec.add_dependency 'dry-types'
   spec.add_dependency 'railties', '>= 6.0'
   spec.add_dependency 'responders'

data/lib/creed/command.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 
 require 'dry-initializer'
+require 'dry-initializer-rails'
 
 class Creed::Command
   extend Dry::Initializer[undefined: false]
 
-  def self.perform(*context)
-    new(*context).perform
+  def self.perform(*context, &block)
+    # Make sure that any given options have their keys symbolized, otherwise they will be ignored,
+    # as Dry::Initializer requires keyword arguments or symbolized keys.
+    options = context.extract_options!
+
+    unless options.empty?
+      options.symbolize_keys!
+
+      # Raise on unknown options.
+      unknown_keys = options.keys - dry_initializer.options.map(&:source)
+      raise ArgumentError, "unknown keys: `#{unknown_keys.join '`, `'}`" if unknown_keys.any?
+    end
+
+    (options.empty? ? new(*context) : new(*context, **options)).perform(&block)
   end
 
   def perform

data/lib/creed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Creed
-  VERSION = '0.2.0'
+  VERSION = '0.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creed
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Joel Moss
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - joel@developwithstyle.com
 executables: []
@@ -112,7 +126,7 @@ metadata:
   homepage_uri: https://github.com/joelmoss/creed
   source_code_uri: https://github.com/joelmoss/creed
   changelog_uri: https://github.com/joelmoss/creed/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
-summary: Command pattern or Rails
+summary: Command pattern for Rails
 test_files: []