callee 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2317b43e6f267fc9a26f587b91f1bf0bc098b26ee1a4a85833b290f4418175ce
-  data.tar.gz: b1a7396d2d8855b7517350a04de073f416c1602f4bbe4e5ed04b840771577bfa
+  metadata.gz: 5bcafa6587f9210c87ea5156944ca31f979ff3f88967901cbd8dc1a74e17639b
+  data.tar.gz: 524208f6a87cd9b00f8984900a25b9d547480ab5b0da48db583a48c244418deb
 SHA512:
-  metadata.gz: e069dfb7c0cc73fb69461d202068bb9e69c16c552d45e191d0530ca31d529e11105656ba71f674183b6a9fc93ee256a0badef1ba82da3bb08642eb242b062898
-  data.tar.gz: f96fbdb129d49169198639bcd2ce02b9e7b73db918131e62841f1601e7ab17215b596cd076cbcc26d461d7051c9f045a7ce173d0b228ca89ec416dbea7af8650
+  metadata.gz: e217d93d28711d73f503fd8300125993a08cfbd0c412259eaa7372af83a59dde50c20ee409ca9763543afd05c61ed8e4337443cf28fe1309bf728de06b4db6c1
+  data.tar.gz: 5591eab6405a51a363acbd962bfa8947b1cff474f0d8b8aea620cac6b3897cb575aa471f8acd93387078271e88f76433d7d9c898a68255c6b7490b63a3ede599

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - 2019-07-07
+## [0.1.2] - 2019-07-28
+
+- Added a readme.
+- Relaxed dependencies.
+
+## [0.1.1] - 2019-07-27
 
 - First public release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    callee (0.1.1)
+    callee (0.1.2)
       dry-initializer (>= 2.5, < 4.0)
 
 GEM

data/README.md

@@ -1,8 +1,6 @@
 # Callee
 
-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/callee`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem helps to define callable classes with strict params specification.
 
 ## Installation
 
@@ -22,7 +20,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To make a class callable, you need to include `Callee` mixin and implement `call` instance method. Use [dry-initializer DSL](https://dry-rb.org/gems/dry-initializer/optionals-and-defaults/) to specify calling parameters and options if necessary. Here is a basic usage example:
+
+``` ruby
+class SumService
+  include Callee
+
+  param :a
+  param :b
+
+  def call
+    a + b
+  end
+end
+
+SumService.call(1, 1) # Will return 2
+```
+
+And one more example, to demonstrate optional params with default values:
+
+``` ruby
+class GreetingService
+  include Callee
+
+  option :greeting, optional: true, default: proc { 'Hello' }
+  option :name, optional: true
+
+  def call
+    "#{[greeting, name].compact.join(', ')}!"
+  end
+end
+
+GreetingService.call # Will return "Hello!"
+GreetingService.call(name: 'Probert') # Will return "Hello, Probert!"
+```
+
+Type constraints and coercion will also work, as usual, just make sure to include `dry-types` (here are [some examples)](https://dry-rb.org/gems/dry-initializer/type-constraints/)).
 
 ## Development
 

data/lib/callee/version.rb

@@ -1,3 +1,3 @@
 module Callee
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callee
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alex Musayev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-27 00:00:00.000000000 Z
+date: 2019-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer