creed 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8c24e8b350f8d12b8f4ec1c4f32b8d916a9ec6326b03d2c3cb98b79fae4eadf
-  data.tar.gz: 3a281613ab1f01ae4e05c94f0f29377a0fc86c174c4ed55d821417ede06daa3d
+  metadata.gz: 71ec85575cece4defb4fb57ca8521494d4c350aef99730269747872e17aa66c1
+  data.tar.gz: 8c15a9cfd8f219140efec5a0d0b82ca6d92dd89020898f065f29ef1ed9ce7365
 SHA512:
-  metadata.gz: 1ebfd0d3cd1c8e4306e8f3040666dd913d9abf811031979156636208a185f7470feb459b6a8bf4e32e2eb718fcb97b19522666fdb52f8608423aafd04587a4b3
-  data.tar.gz: 4f9c513412ce5e8f55a6c56f4d93074c4563b34982281bca881562f9240a1c772f06db1a7567e37cc042ce97f9fc04bb5fd66a6d4d2da9db07678f3b6104a08d
+  metadata.gz: '085d2028e4f104d642cda0490d94b6d91d100bd02f1f179fb9124592529a426c593b200d144c945bea4bb7c109b2650e6e822f486bbb5f75d9c78af37472876b'
+  data.tar.gz: bd7c1d695f8f63cd5db1b1e7e586bdc35f56a9fa6983448ab8b67669e8ae33b1201fa1ac4a778fc1843ffc201c065c76b99488980ca5ab91a9bc29722ebeb221

data/README.md

@@ -1,8 +1,6 @@
-# Creed
+# Creed - Stupid Simple Commands for Rails
 
-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/creed`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Creed provides a stupid simple way to introduce the [Command Pattern](https://en.wikipedia.org/wiki/Command_pattern) to your Rails app.
 
 ## Installation
 
@@ -22,7 +20,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create your Command classes in `app/commands`, extending `Creed::Command`, and implementing a `perform` method:
+
+```ruby
+class CreateUser < Creed::Command
+  # Define types and/or validations.
+  param :user_params, Creed::Types.Instance(ActionController::Parameters)
+
+  def perform
+    # Do something here...
+  end
+end
+```
+
+Then in your controller (or anywhere):
+
+```ruby
+class UserController < ApplicationController
+  def create
+    CreateUser.perform(user_params)
+  end
+end
+```
 
 ## Development
 
@@ -34,7 +53,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/creed. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/creed/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/creed/railtie.rb

@@ -3,7 +3,7 @@
 module Creed
   class Railtie < Rails::Railtie
     config.before_configuration do |app|
-      app.config.paths.add 'app/controllers/commands', eager_load: true
+      app.config.paths.add 'app/commands', eager_load: true
     end
   end
 end

data/lib/creed/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack