lab42_basic_constraints 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c88af59f506668cbc7c56fffc54c3430f31a0ebf5ad7d697dd3aadebf6ef5192
+  data.tar.gz: 84bedc52d927607fbdbc5d108d56d23ab02d8931fb939567a06ece934c9903a5
+SHA512:
+  metadata.gz: 27926e413ebcf7801f572816d6fe5d23ad340d972526ca4d25246e927d118e7073d789b6f167c61c569067097c0bf761b1a707d151320d30400bbb19558e3113
+  data.tar.gz: f49c25cdf9c96bc9e0da08d7e7783774dd0c511a814a0431360bdb88a208c836cf15d6b35beb3469558ed93a5674377d56993b1b509e4cb9fe13260f65a20632

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,122 @@
+
+[![Gem Version](https://badge.fury.io/rb/lab42_basic_constraints.svg)](http://badge.fury.io/rb/lab42_basic_constraints)
+
+
+# Lab42::BasicConstraints
+
+**N.B.** All these code examples are verified with [the speculate_about gem](https://rubygems.org/gems/speculate_about/)
+
+
+A collection of constraints
+
+## Context A Quick Overview
+
+Given That we alias `Lab42::BasicConstraints` to `BC`
+
+```ruby
+  require "lab42/basic_constraints/alias"
+```
+
+Then All Basic Constraints can be listed by means of `BC.all_constraints`
+
+```ruby
+    all_basic_constraints = %i[
+     all_digits_string alphanumeric_string
+     bool
+     date date_time day
+     hour
+     lowercase_string
+     minute month
+     non_empty_string non_negative_float non_negative_int non_negative_number
+     positive_float positive_int positive_number
+     second
+     time
+     uppercase_string
+     year
+    ]
+
+    expect( BC.all_constraints ).to eq(all_basic_constraints)
+```
+
+## So we got the ball, now use it!
+
+The ball, BTW, is a `Lab42::Result` see [lab42_result gem](https://rubygems.org/gems/lab42_result/) for more info
+
+Given the `non_negative_int` constraint
+
+```ruby
+    let(:non_neg_int) {BC.non_negative_int}
+```
+
+Then we can just call it
+
+```ruby
+    non_neg_int.(0) in [:ok, nil]
+    non_neg_int.(-1) in [error, message]
+    expect(error).to eq(BC::ConstraintError)
+    expect(message).to eq("-1 is not a legal non_negative_int")
+```
+
+Example: Get a constraint by symbol
+
+```ruby
+    pn = BC.from_symbol(:positive_number)
+    pn.(1) in [:ok, nil]
+```
+
+Example: Constraints with and without defaults
+
+```ruby
+    expect {BC.from_symbol(:positive_number).default}
+      .to raise_error(Lab42::BasicConstraints::MissingDefaultError, "Constraint positive_number has no predefined default")
+
+    expect( BC.non_negative_int.default ).to eq(0)
+
+```
+
+A detailed description of all constraints can be found
+[here](speculations/constraints.md)
+
+## Context We are still in Beta and therefor
+
+Example: Some constraints are not yet implemented
+
+```ruby
+    expect{ BC.all_digits_string }.to raise_error(NotImplementedError)
+```
+
+## Context Time's a Sticky Wicket
+
+... but as defaults are defined for runtime that shall really help us with that
+
+Given that we have timecop
+
+```ruby
+    require "timecop"
+    let(:d) {BC.date}
+    let(:error) {Lab42::BasicConstraints::ConstraintError}
+```
+Then we can show that the year's default value will not be at compile time  but at runtime:
+
+```ruby
+  year = BC.year
+  Timecop.freeze(Time.utc(1905)) do
+    expect( year.default ).to eq(1905)
+  end
+```
+
+Of course a check for legality is performed
+
+Example: Illegal Dates
+
+```ruby
+    d.("2020-00-01") in [raised, message ]
+    expect( raised ).to eq(error)
+    expect( message ).to eq("2020-00-01 is not a legal date")
+```
+
+# LICENSE
+
+Copyright 2020 Robert Dober robert.dober@gmail.com
+
+Apache-2.0 [c.f LICENSE](LICENSE)

data/lib/lab42/basic_constraints.rb

@@ -0,0 +1,59 @@
+require_relative "basic_constraints/implementation.rb"
+module Lab42
+  module BasicConstraints extend self
+    Constraints = {
+       all_digits_string: :not_yet_implemented,
+       alphanumeric_string: :not_yet_implemented,
+
+       bool: ->(x){[false, true].include? x},
+
+       date: :date,
+       date_time: :not_yet_implemented,
+       day: :not_yet_implemented,
+
+       hour: :not_yet_implemented,
+
+       lowercase_string: :not_yet_implemented,
+
+       minute: :not_yet_implemented,
+       month: :not_yet_implemented,
+    
+       non_empty_string: :not_yet_implemented,
+       non_negative_float: :not_yet_implemented,
+       non_negative_int: :non_negative_int,
+
+       non_negative_number: :not_yet_implemented,
+
+       positive_float: :not_yet_implemented,
+       positive_int: :not_yet_implemented,
+       positive_number: :positive_number,
+
+       second: :not_yet_implemented,
+
+       time: :not_yet_implemented,
+
+       uppercase_string: :not_yet_implemented,
+
+       year: :year
+    }
+    def all_constraints
+      Constraints.keys
+    end
+
+    def from_symbol name, *args, **kwds, &blk
+      cons = Constraints.fetch(name, &blk)
+      case cons
+      # when Constraint
+      #   cons
+      when Proc
+        Constraint.new(name, &cons)
+      when Symbol
+        Implementation.send(cons, *args, **kwds)
+      end
+    end
+
+    def method_missing(name, *args, **kwds)
+      from_symbol(name, *args, **kwds) {super}
+    end
+  end
+end

data/lib/lab42/basic_constraints/alias.rb

@@ -0,0 +1,2 @@
+require_relative "../basic_constraints"
+BC = Lab42::BasicConstraints

data/lib/lab42/basic_constraints/constraint.rb

@@ -0,0 +1,50 @@
+require "lab42/result"
+Result = Lab42::Result
+module Lab42
+  module BasicConstraints
+    ConstraintError = Class.new RuntimeError
+    MissingDefaultError = Class.new RuntimeError
+    class Constraint
+
+      def call value
+        return Result.ok if @constraint.(value)
+        Result.error("#{_show value} is not a legal #{@name}", error: Lab42::BasicConstraints::ConstraintError)
+      end
+
+      def default
+        case @default
+        when Proc
+          @default.()
+        else
+          @default
+        end
+      end
+
+      def set_default value=nil, &blk
+        @default = 
+          if value
+            value
+          else
+            blk
+          end
+        self
+      end
+
+      private
+      def _show value
+        case value
+        when NilClass
+          "nil"
+        else
+          value
+        end
+      end
+
+      def initialize name, &blk
+        @constraint = blk
+        @default = -> {raise Lab42::BasicConstraints::MissingDefaultError, "Constraint #{name} has no predefined default"}
+        @name = name
+      end
+    end
+  end
+end

data/lib/lab42/basic_constraints/implementation.rb

@@ -0,0 +1,45 @@
+require_relative "constraint" 
+module Lab42
+  module BasicConstraints
+
+    module Implementation extend self
+
+      def date default: nil
+        require "date"
+        Constraint.new(:date) do |value|
+          Date.parse(value) rescue false
+        end
+          .set_default default do
+          Date.today.iso8601
+        end
+      end
+
+      def non_negative_int
+        Constraint.new :non_negative_int do |value|
+          Integer === value && value >= 0
+        end
+          .set_default(0)
+      end
+
+      def positive_number
+        Constraint.new :positive_number do |value|
+          Integer === value && value > 0 ||
+            Float === value && value > 0.0
+        end
+      end
+
+      def not_yet_implemented
+        raise NotImplementedError
+      end
+
+      def year
+        Constraint.new(:year) do |value|
+          Integer === value
+        end
+          .set_default do 
+            Time.now.utc.year
+          end
+      end
+    end
+  end
+end

data/lib/lab42/basic_constraints/version.rb

@@ -0,0 +1,5 @@
+module Lab42
+  module BasicConstraints
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: lab42_basic_constraints
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Robert Dober
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lab42_result
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Constraints like :positive_int, :non_empty_string, ...
+email: robert.dober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/lab42/basic_constraints.rb
+- lib/lab42/basic_constraints/alias.rb
+- lib/lab42/basic_constraints/constraint.rb
+- lib/lab42/basic_constraints/implementation.rb
+- lib/lab42/basic_constraints/version.rb
+homepage: https://bitbucket.org/robertdober/lab42_basic_constraints
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Basic, useful and recurring constraints
+test_files: []