shiyo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01a8618ea358901acad9f198594959ce443730b01447cf5e47ceca99aaa695cf
-  data.tar.gz: 3e6685943a96003656e015de60ca82bcd38b055380bf20fabf5bfc81953cff62
+  metadata.gz: d3cac64b3952eb7ca2cbc28c4c28bc0be7abad2dcab019e880f0dbd995191151
+  data.tar.gz: 867b20167b0327492d8011a6e90388683b7c0dae3ae22edba9b2b2e7f81a60c0
 SHA512:
-  metadata.gz: 9a1483a64c112872659b413ba762ad9b3f8d68a74ee390820d2c1a566d54479d47aa05e4ccc6ab73908fe163b51f91e00add1443fe859889041bdd75ea6fc525
-  data.tar.gz: 80c7ea2aa246bb9482c961cf10cbcfa957e4b86c088f3f34668e8315a42aad23b65fe4322077229cba271c8a1b05adb9512c8d35b371bd89e970083b83952dd5
+  metadata.gz: 78bdf7228c8377b54675046eaaa650183f147974bd56e429422bf0ddf44c1e3241ed2cc7fb17c1c7944584b3b12673f6a545659d29f88575333311b1fc2bf774
+  data.tar.gz: df0044517dd0589b2b476b645d2c3dce47eec94d6239f001a71cfdf0e8362c795ecd6b67d242e8725c6b8a0aa3d7570f6dddceeb6bb9e6469e11e7170cc1a7a5

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 ## [Unreleased]
+## [0.1.1] - 2022-03-15
+
+- Install `bump` gem
+- Trivial refactorings
 
 ## [0.1.0] - 2022-03-12
 

data/Gemfile

@@ -14,3 +14,5 @@ gem "rubocop", "~> 1.21"
 gem "rubocop-rspec", "~> 2.9"
 
 gem "yard", "~> 0.9"
+
+gem "bump", "~> 0.10"

data/README.md

@@ -1,12 +1,14 @@
 # Shiyo
 [![johnny-miyake](https://circleci.com/gh/johnny-miyake/shiyo.svg?style=svg)](https://github.com/johnny-miyake/shiyo)
 
-Shiyo is a minimal framework that supports writing your business rules using the Specification pattern.
-It enables to build composite specifications by method chaining like;
+Shiyo is a minimal framework that supports writing your business rules using the [Specification pattern](https://en.wikipedia.org/wiki/Specification_pattern).
+It helps you to build a composite specification by method chaining like;
 ```ruby
 spec1.and(spec2.or(spec3)).satisfied_by?(candidate)
 ```
 
+[API documentation](https://www.rubydoc.info/gems/shiyo)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,7 +26,12 @@ Or install it yourself as:
     $ gem install shiyo
 
 ## Usage
+You can create your own Shiyo specification as following steps;
+1. Include `Shiyo::Specification` module into your class.
+2. Implement `#satisfied_by?`.
+3. (optional) Implement `#initialize` if needed.
 
+For example;
 ```ruby
 # A specification class
 class ContainerFeatureSpec

data/lib/shiyo/and.rb

@@ -10,7 +10,6 @@ module Shiyo
     # @param one [Shiyo::Specification] A specification object.
     # @param other [Shiyo::Specification] The other specification object.
     def initialize(one, other)
-      super()
       @one = Shiyo::Specification(one)
       @other = Shiyo::Specification(other)
     end

data/lib/shiyo/not.rb

@@ -9,7 +9,6 @@ module Shiyo
     #
     # @param wrapped [Shiyo::Specification] A specification object.
     def initialize(wrapped)
-      super()
       @wrapped = Shiyo::Specification(wrapped)
     end
 

data/lib/shiyo/or.rb

@@ -10,7 +10,6 @@ module Shiyo
     # @param one [Shiyo::Specification] A specification object.
     # @param other [Shiyo::Specification] The other specification object.
     def initialize(one, other)
-      super()
       @one = Shiyo::Specification(one)
       @other = Shiyo::Specification(other)
     end

data/lib/shiyo/{syntax_sugger.rb → syntax_sugar.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Shiyo
-  # The module to provide syntax suggers.
-  module SyntaxSugger
+  # The module to provide syntax sugars.
+  module SyntaxSugar
     # rubocop:disable Naming/MethodName
 
-    # The syntax sugger for `Shiyo::Not.new`
+    # The syntax sugar for `Shiyo::Not.new`
     # @param object Any object.
     # @return [Shiyo::Not]
     def Not(object)

data/lib/shiyo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shiyo
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/shiyo.rb

@@ -3,7 +3,7 @@
 require_relative "shiyo/error"
 require_relative "shiyo/version"
 require_relative "shiyo/conversion"
-require_relative "shiyo/syntax_sugger"
+require_relative "shiyo/syntax_sugar"
 require_relative "shiyo/specification"
 require_relative "shiyo/and"
 require_relative "shiyo/or"
@@ -12,5 +12,5 @@ require_relative "shiyo/not"
 # The top module of Shiyo
 module Shiyo
   extend Shiyo::Conversion
-  extend Shiyo::SyntaxSugger
+  extend Shiyo::SyntaxSugar
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiyo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Takuma Miyake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies: []
 description: "    Shiyo is a minimal framework that supports writing your business
   rules using the Specification pattern.\n"
@@ -33,7 +33,7 @@ files:
 - lib/shiyo/not.rb
 - lib/shiyo/or.rb
 - lib/shiyo/specification.rb
-- lib/shiyo/syntax_sugger.rb
+- lib/shiyo/syntax_sugar.rb
 - lib/shiyo/version.rb
 - sig/shiyo.rbs
 homepage: https://github.com/johnny-miyake/shiyo