logica 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f7c39b53470ab8de4b254289de127f5381dd1e5
+  data.tar.gz: 5b6c07bb425e77e05aac88438db2b433dec846fc
+SHA512:
+  metadata.gz: e1c8605b2591fdd244bdb060655a4599a6d46b9f630b737c53b70733a335e43c93ad90491e31800f4027cf00a2d00b6b133a2ef41ab45a9909050ffca54d0fb1
+  data.tar.gz: 7c9eccba730c03480e363eed52bcd3fb61521c94ab93bb215a2b856591508bab57fffd2f15221563f1321844ac6168e3676fbbeae78dea522c38c38f9c37e08c

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.15.1

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Logica Changelog
+
+All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning][Semver].
+
+## [Unreleased]
+
+* Your contribution here!
+
+## 0.0.1 (2017-06-20)
+
+* Initial release
+
+[Semver]: http://semver.org
+[Unreleased]: https://github.com/eugeniobruno/logica/compare/v0.0.1...HEAD

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at eugeniobruno@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logica.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eugenio Bruno
+
+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,91 @@
+# Logica
+
+[![Gem Version](https://badge.fury.io/rb/logica.svg)](https://badge.fury.io/rb/logica)
+[![Build Status](https://travis-ci.org/eugeniobruno/logica.svg?branch=master)](https://travis-ci.org/eugeniobruno/logica)
+[![Coverage Status](https://coveralls.io/repos/github/eugeniobruno/logica/badge.svg?branch=master)](https://coveralls.io/github/eugeniobruno/logica?branch=master)
+[![Code Climate](https://codeclimate.com/github/eugeniobruno/logica.svg)](https://codeclimate.com/github/eugeniobruno/logica)
+[![Dependency Status](https://gemnasium.com/eugeniobruno/logica.svg)](https://gemnasium.com/eugeniobruno/logica)
+
+Logica is a reusable implementation of the Specification design pattern, or a framework to manage predicates of arbitrary complexity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logica'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logica
+
+## Usage
+
+Here is a simple example:
+
+```ruby
+class IsEven < Logica::Predicates::Base
+
+  def satisfied_by?(number)
+    number.even?
+  end
+
+end
+
+class IsGreaterThan < Logica::Predicates::Base
+
+  attr_reader :threshold
+
+  def initialize(threshold)
+    @threshold = threshold
+  end
+
+  def satisfied_by?(number)
+    number > threshold
+  end
+
+end
+
+is_even = IsEven.new
+
+is_even.satisfied_by?(1)    # false
+is_even.satisfied_by?(2)    # true
+
+is_even.negated.satisfied_by?(3)    # true
+is_even.negated.satisfied_by?(4)    # false
+
+is_greater_than_five = IsGreaterThan.new(5)
+
+is_greater_than_five.satisfied_by?(5) # false
+is_greater_than_five.satisfied_by?(6) # true
+
+is_even.and(is_greater_than_five).satisfied_by?(6) # true
+is_even.and(is_greater_than_five).satisfied_by?(7) # false
+
+is_even.or(is_greater_than_five).satisfied_by?(8) # true
+is_even.or(is_greater_than_five).satisfied_by?(9) # true
+```
+
+More examples that show many more features can be found in the test files.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eugeniobruno/logica. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task default: :test
+
+desc 'Start a REPL session'
+task :console do
+  require 'logica'
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'logica'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/logica/comparable_by_state.rb

@@ -0,0 +1,24 @@
+module Logica
+  module ComparableByState
+    def ==(other)
+      other.instance_of?(self.class) && other.state == state
+    end
+    alias_method :eql?, :==
+
+    def hash
+      state.hash
+    end
+
+    def state
+      attributes
+    end
+
+    private
+
+    def attributes
+      instance_variables.each_with_object({}) do |name, h|
+        h[name[1..-1].to_sym] = instance_variable_get(name)
+      end
+    end
+  end
+end

data/lib/logica/predicate_factory.rb

@@ -0,0 +1,111 @@
+module Logica
+  class PredicateFactory
+    def conjunction(predicates)
+      compound_from_list(predicates, conjunction_class)
+    end
+
+    def conjunction_from_pair(first_predicate, second_predicate)
+      compound_from_pair(first_predicate, second_predicate, conjunction_class)
+    end
+
+    def disjunction(predicates)
+      compound_from_list(predicates, disjunction_class)
+    end
+
+    def disjunction_from_pair(first_predicate, second_predicate)
+      compound_from_pair(first_predicate, second_predicate, disjunction_class)
+    end
+
+    def negation(predicate)
+      negation_class.new(predicate)
+    end
+
+    def at_least(minimum, predicates)
+      if minimum <= 0
+        tautology
+      elsif minimum == 1
+        disjunction(predicates)
+      elsif minimum == predicates.size
+        conjunction(predicates)
+      elsif minimum >= predicates.size
+        contradiction
+      else
+        at_least_class.new(minimum, predicates)
+      end
+    end
+
+    def at_most(maximum, predicates)
+      minimum   = predicates.size - maximum
+      negations = predicates.map(&:negated)
+
+      at_least(minimum, negations)
+    end
+
+    def between(minimum, maximum, predicates)
+      at_least(minimum, predicates).and(at_most(maximum, predicates))
+    end
+
+    def exactly(amount, predicates)
+      between(amount, amount, predicates)
+    end
+
+    def tautology
+      tautology_class.new
+    end
+
+    def contradiction
+      contradiction_class.new
+    end
+
+    def ad_hoc(name = 'anonymous', &definition)
+      ad_hoc_class.new(name, &definition)
+    end
+    alias_method :from_block, :ad_hoc
+
+    def partial_application(predicate, *first_arguments)
+      partial_application_class.new(predicate, *first_arguments)
+    end
+
+    private
+
+    def compound_from_list(predicates, compound_class)
+      compound_class.new_from_list(predicates)
+    end
+
+    def compound_from_pair(first_predicate, second_predicate, compound_class)
+      compound_class.new_from_pair(first_predicate, second_predicate)
+    end
+
+    def negation_class
+      Predicates::Negation
+    end
+
+    def conjunction_class
+      Predicates::Compounds::Conjunction
+    end
+
+    def disjunction_class
+      Predicates::Compounds::Disjunction
+    end
+
+    def at_least_class
+      Predicates::Compounds::AtLeast
+    end
+
+    def tautology_class
+      Predicates::Tautology
+    end
+
+    def contradiction_class
+      Predicates::Contradiction
+    end
+
+    def ad_hoc_class
+      Predicates::AdHoc
+    end
+
+    def partial_application_class
+      Predicates::PartialApplication
+    end
+  end
+end

data/lib/logica/predicates/ad_hoc.rb

@@ -0,0 +1,16 @@
+module Logica
+  module Predicates
+    class AdHoc < Base
+      attr_reader :name
+
+      def initialize(name, &definition)
+        @name = name
+        define_singleton_method :satisfied_by?, &definition
+      end
+
+      def name_and_attributes
+        "#{name}()"
+      end
+    end
+  end
+end

data/lib/logica/predicates/base.rb

@@ -0,0 +1,210 @@
+module Logica
+  module Predicates
+    class Base
+      include ComparableByState
+      include OpenHouse::Acceptor
+
+      ACCEPTOR_TYPE_ID = :predicate
+
+      def self.predicate_factory
+        Logica.predicate_factory
+      end
+
+      def unsatisfied_by?(*arguments)
+        !satisfied_by?(*arguments)
+      end
+
+      def and(other)
+        other.and_with_other(self)
+      end
+
+      def or(other)
+        other.or_with_other(self)
+      end
+
+      def negated
+        predicate_factory.negation(self)
+      end
+
+      def and_not(other)
+        self.and(other.negated)
+      end
+
+      def or_not(other)
+        self.or(other.negated)
+      end
+
+      def xor(other)
+        self.or(other).and(self.and(other).negated)
+      end
+
+      def implies(other)
+        negated.or(other)
+      end
+
+      def iff(other)
+        # this is equivalent to xor(other).negated
+        self.and(other).or(self.or(other).negated)
+      end
+
+      def specialization_of?(other)
+        other.generalization_of_other?(self)
+      end
+
+      def generalization_of?(other)
+        other.specialization_of?(self)
+      end
+
+      def generalization_of_other?(other)
+        other == self
+      end
+
+      def generalization_of_negation_of?(other)
+        false
+      end
+
+      def disjoint_with?(other)
+        other.disjoint_with_other?(self)
+      end
+
+      def exhaustive_with?(other)
+        other.exhaustive_with_other?(self)
+      end
+
+      def portion_satisfied_by(*arguments)
+        satisfied_by?(*arguments) ? self : predicate_factory.tautology
+      end
+
+      def remainder_unsatisfied_by(*arguments)
+        satisfied_by?(*arguments) ? predicate_factory.contradiction : self
+      end
+
+      def partially_applied_with(*first_arguments)
+        return self if first_arguments.empty?
+        validate_partial_application(first_arguments)
+        do_partially_applied_with(first_arguments)
+      end
+
+      def to_method
+        method(:satisfied_by?)
+      end
+
+      def arity
+        to_method.arity
+      end
+
+      def to_proc
+        to_method.to_proc
+      end
+
+      def to_s
+        "#{name_and_attributes}#{to_s_suffix}"
+      end
+
+      def name_and_attributes
+        "#{name}(#{attributes.values.join(', ')})"
+      end
+
+      def method_missing(name, *args, &block)
+        if name.to_s.start_with?('and_with_')
+          and_with_other(*args)
+        elsif name.to_s.start_with?('or_with_')
+          or_with_other(*args)
+        elsif name.to_s.start_with?('generalization_of_')
+          generalization_of_other?(*args)
+        elsif name.to_s.start_with?('disjoint_with_')
+          disjoint_with_other?(*args)
+        elsif name.to_s.start_with?('exhaustive_with_')
+          exhaustive_with_other?(*args)
+        else
+          ret = do_method_missing(name, *args, &block)
+          ret == :__super__ ? super : ret
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        prefixes = %w(and_with or_with generalization_of_ disjoint_with_ exhaustive_with_)
+
+        prefixes.any? { |prefix| method_name.to_s.start_with?(prefix) } ||
+          begin
+            ret = do_respond_to_missing?(method_name, include_private)
+            ret == :__super__ ? super : ret
+          end
+      end
+
+      protected
+
+      def and_with_conjunction(conjunction)
+        conjunction.with_extra_predicate_last(self)
+      end
+
+      def and_with_at_least(at_least)
+        at_least.and_with_other(self, other_first: false)
+      end
+
+      def and_with_other(other)
+        predicate_factory.conjunction_from_pair(other, self)
+      end
+
+      def or_with_disjunction(disjunction)
+        disjunction.with_extra_predicate_last(self)
+      end
+
+      def or_with_other(other)
+        predicate_factory.disjunction_from_pair(other, self)
+      end
+
+      def generalization_of_conjunction?(conjunction)
+        conjunction.specialization_of_other?(self)
+      end
+
+      def disjoint_with_other?(other)
+        specialization_of?(other.negated)
+      end
+
+      def exhaustive_with_other?(other)
+        negated.specialization_of?(other)
+      end
+
+      def without_predicates(preds, options = {})
+        preds.include?(self) ? [] : [self]
+      end
+
+      def to_s_suffix
+        " |#{arity}|"
+      end
+
+      private
+
+      def validate_partial_application(first_arguments)
+        if first_arguments.size > arity
+          raise ArgumentError, partial_application_error_message(first_arguments)
+        end
+      end
+
+      def partial_application_error_message(first_arguments)
+        "cannot partially apply #{self} with #{first_arguments} (too many arguments)"
+      end
+
+      def do_partially_applied_with(first_arguments)
+        predicate_factory.partial_application(self, first_arguments)
+      end
+
+      def name
+        self.class.name.split('::').last
+      end
+
+      def predicate_factory
+        self.class.predicate_factory
+      end
+
+      def do_method_missing(name, *args, &block)
+        :__super__
+      end
+
+      def do_respond_to_missing?(method_name, include_private = false)
+        :__super__
+      end
+    end
+  end
+end