shiyo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01a8618ea358901acad9f198594959ce443730b01447cf5e47ceca99aaa695cf
+  data.tar.gz: 3e6685943a96003656e015de60ca82bcd38b055380bf20fabf5bfc81953cff62
+SHA512:
+  metadata.gz: 9a1483a64c112872659b413ba762ad9b3f8d68a74ee390820d2c1a566d54479d47aa05e4ccc6ab73908fe163b51f91e00add1443fe859889041bdd75ea6fc525
+  data.tar.gz: 80c7ea2aa246bb9482c961cf10cbcfa957e4b86c088f3f34668e8315a42aad23b65fe4322077229cba271c8a1b05adb9512c8d35b371bd89e970083b83952dd5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '**/*.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at j.e.miyake@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shiyo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rubocop-rspec", "~> 2.9"
+
+gem "yard", "~> 0.9"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Takuma Miyake
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# 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;
+```ruby
+spec1.and(spec2.or(spec3)).satisfied_by?(candidate)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "shiyo"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install shiyo
+
+## Usage
+
+```ruby
+# A specification class
+class ContainerFeatureSpec
+  include Shiyo::Specification
+
+  TYPE = { armored: "armored", ventilated: "ventilated" }.freeze
+
+  def initialize container_feature
+    @container_feature = TYPE.fetch(container_feature)
+  end
+
+  def satisfied_by? container
+    container.feature.to_s == @container_feature
+  end
+end
+
+# Another specification class
+class ContainerUsedSpec
+  include Shiyo::Specification
+
+  def initialize used:
+    @used = used
+  end
+
+  def satisfied_by? container
+    container.used? == @used
+  end
+end
+
+# The class of the candidate object
+class Container
+  attr_reader :feature
+
+  def initialize feature, used: false
+    @feature = feature
+    @used = !!used
+  end
+
+  def used?
+    @used
+  end
+end
+
+# containers
+brand_new_armored_container = Container.new(:armored, used: false)
+used_ventilated_container = Container.new(:ventilated, used: true)
+used_cheep_container = Container.new(:cheep, used: true)
+
+# simple specifications
+armored_spec = ContainerFeatureSpec.new(:armored)
+ventilated_spec = ContainerFeatureSpec.new(:ventilated)
+used_spec = ContainerUsedSpec.new(used: true)
+brand_new_spec = ContainerUsedSpec.new(used: false)
+
+armored_spec.satisfied_by?(brand_new_armored_container)
+#=> true
+armored_spec.satisfied_by?(used_ventilated_container)
+#=> false
+used_spec.satisfied_by?(used_ventilated_container)
+#=> true
+
+# composite specifications
+used_ventilated_spec = ventilated_spec.and(used_spec)
+brand_new_ventilated_spec = ventilated_spec.and(brand_new_spec)
+cheep_spec = Shiyo::Not(armored_spec.or(ventilated_spec))
+
+used_ventilated_spec.satisfied_by?(used_ventilated_container)
+#=> true
+brand_new_ventilated_spec.satisfied_by?(used_ventilated_container)
+#=> false
+cheep_spec.satisfied_by?(used_cheep_container)
+#=> true
+armored_spec.satisfied_by?(used_cheep_container)
+#=> false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/johnny-miyake/shiyo. 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/johnny-miyake/shiyo/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).
+
+## Code of Conduct
+
+Everyone interacting in the Shiyo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/johnny-miyake/shiyo/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/shiyo/and.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Shiyo
+  # The class to create a composite specification for checking
+  # whether the candidate satisfies both of the two specifications.
+  class And
+    include Shiyo::Specification
+    # A new instance of Shiyo::And
+    #
+    # @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
+
+    # Inspects whether the candidate satisfies the both of the wrapped specifications.
+    #
+    # @param candidate [Object] The candidate object to be inspected.
+    # @return [Boolean] The result.
+    def satisfied_by?(candidate)
+      @one.satisfied_by?(candidate) && @other.satisfied_by?(candidate)
+    end
+  end
+end

data/lib/shiyo/conversion.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Shiyo
+  # The module to provide conversion methods.
+  module Conversion
+    # rubocop:disable Naming/MethodName
+
+    # Ensures the object to be a Shiyo compatible object.
+    # @param object Any object.
+    # @raise [Shiyo::ConversionError]
+    def Specification(object)
+      check_compatibility_of(object)
+    end
+    # rubocop:enable Naming/MethodName
+
+    module_function
+
+    # A private method used by `#Specification()`.
+    # @!visibility private
+    def check_compatibility_of(object)
+      object.to_shiyo
+    rescue NoMethodError => e
+      raise Shiyo::Error::IncompatibleObject, <<~MESSAGE
+        #{e.message}
+        Can't convert #{object} into Shiyo compatible object.
+        The class of the object must include `Shiyo::Specification`,
+          or have `#to_shiyo()` for compatibility.
+      MESSAGE
+    end
+  end
+end

data/lib/shiyo/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Shiyo
+  module Error
+    class ShiyoError < StandardError; end
+
+    class IncompatibleObject < ShiyoError; end
+  end
+end

data/lib/shiyo/not.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Shiyo
+  # The class to create a wrapper specification for checking
+  # whether the candidate does not satisfy the wrapped specification.
+  class Not
+    include Shiyo::Specification
+    # A new instance of Shiyo::Not
+    #
+    # @param wrapped [Shiyo::Specification] A specification object.
+    def initialize(wrapped)
+      super()
+      @wrapped = Shiyo::Specification(wrapped)
+    end
+
+    # Inspects whether the candidate does not satisfy the wrapped specification.
+    #
+    # @param candidate [Object] The candidate object to be inspected.
+    # @return [Boolean] The result.
+    def satisfied_by?(candidate)
+      !@wrapped.satisfied_by?(candidate)
+    end
+  end
+end

data/lib/shiyo/or.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Shiyo
+  # The class to create a composite specification for checking
+  # whether the candidate satisfies any of the two specifications.
+  class Or
+    include Shiyo::Specification
+    # A new instance of Shiyo::Or
+    #
+    # @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
+
+    # Inspects whether the candidate satisfies any of the wrapped specifications.
+    #
+    # @param candidate [Object] The candidate object to be inspected.
+    # @return [Boolean] The result.
+    def satisfied_by?(candidate)
+      @one.satisfied_by?(candidate) || @other.satisfied_by?(candidate)
+    end
+  end
+end

data/lib/shiyo/specification.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Shiyo
+  # The mixin module that provides basic methods to implement user specifications.
+  module Specification
+    # Composes a Spec::And specification of self and the other specification.
+    #
+    # @param other [Shiyo::Specification] A specification object to combine with self.
+    # @return [Shiyo::And] The composed specification.
+    def and(other)
+      Shiyo::And.new(self, other)
+    end
+
+    # Composes a Spec::Or specification of self and the other specification.
+    #
+    # @param other [Shiyo::Specification] A specification object to combine with self.
+    # @return [Shiyo::Or] The composed specification.
+    def or(other)
+      Shiyo::Or.new(self, other)
+    end
+
+    # Inspects whether the candidate satisfies the the specification.
+    # This method must be overridden by the class that includes this module.
+    #
+    # @param candidate [Object] The candidate object to be inspected.
+    # @return [void]
+    # @raise [NotImplementedError]
+    def satisfied_by?(_candidate)
+      raise NotImplementedError, "Implement your inspection code."
+    end
+
+    def to_shiyo
+      self
+    end
+  end
+end

data/lib/shiyo/syntax_sugger.rb

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

data/lib/shiyo/version.rb

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

data/lib/shiyo.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "shiyo/error"
+require_relative "shiyo/version"
+require_relative "shiyo/conversion"
+require_relative "shiyo/syntax_sugger"
+require_relative "shiyo/specification"
+require_relative "shiyo/and"
+require_relative "shiyo/or"
+require_relative "shiyo/not"
+
+# The top module of Shiyo
+module Shiyo
+  extend Shiyo::Conversion
+  extend Shiyo::SyntaxSugger
+end

data/sig/shiyo.rbs

@@ -0,0 +1,4 @@
+module Shiyo
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: shiyo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takuma Miyake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-13 00:00:00.000000000 Z
+dependencies: []
+description: "    Shiyo is a minimal framework that supports writing your business
+  rules using the Specification pattern.\n"
+email:
+- j.e.miyake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shiyo.rb
+- lib/shiyo/and.rb
+- lib/shiyo/conversion.rb
+- lib/shiyo/error.rb
+- lib/shiyo/not.rb
+- lib/shiyo/or.rb
+- lib/shiyo/specification.rb
+- lib/shiyo/syntax_sugger.rb
+- lib/shiyo/version.rb
+- sig/shiyo.rbs
+homepage: https://github.com/johnny-miyake/shiyo
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/johnny-miyake/shiyo
+  source_code_uri: https://github.com/johnny-miyake/shiyo
+  changelog_uri: https://github.com/johnny-miyake/shiyo/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A minimal framework for the Specification pattern.
+test_files: []