Refactor/extract builtin contracts

[PikachuEXE]

This is for a comment in another PR

Changes

• Create module Builtin as suggested
• Change all references in code
• Change all references in doc
• Auto include Builtin when module Contracts included
  (but not when extended, since I am not sure)

Missing stuff

• Test for built-in contract usage without namespacing when Contracts included

[alex-fedorov]

You can include Builtin into Contracts directly at a module level. Then you
don't need to call include Builtin inside of included.

This way you can still refer them as Contracts::Maybe anywhere.

Then I would add to tutorial example what happens if including
Contracts::Builtin directly
On Sep 14, 2015 4:08 AM, "PikachuEXE" [email protected] wrote:

This is for a comment in another PR
#198 (comment)
Changes

• Create module Builtin as suggested
• Change all references in code
• Change all references in doc
• Auto include Builtin when module Contracts included (but not when
  extended, since I am not sure)

Missing stuff

• Test for built-in contract usage without namespacing when Contracts
  included

---

You can view, comment on, or merge this pull request online at:

#199
Commit Summary

• * Move Built in contract classes into namespace Builtin
• ~ Change doc for changed namespace
• * Ensure when module Contracts is included, Builtin module is
  also included

File Changes

• M README.md
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-0
  (4)
• M TUTORIAL.md
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-1
  (14)
• M features/builtin_contracts/README.md
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-2
  (2)
• M lib/contracts.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-3
  (9)
• M lib/contracts/builtin_contracts.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-4
  (704)
• M lib/contracts/call_with.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-5
  (8)
• M lib/contracts/formatters.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-6
  (4)
• M lib/contracts/validators.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-7
  (4)
• M spec/builtin_contracts_spec.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-8
  (8)
• M spec/contracts_spec.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-9
  (4)
• M spec/fixtures/fixtures.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-10
  (144)
• M spec/module_spec.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-11
  (2)
• M spec/override_validators_spec.rb
  https://github.com/egonSchiele/contracts.ruby/pull/199/files#diff-12
  (10)

Patch Links:

• https://github.com/egonSchiele/contracts.ruby/pull/199.patch
• https://github.com/egonSchiele/contracts.ruby/pull/199.diff

—
Reply to this email directly or view it on GitHub
#199.

[PikachuEXE]

So the desired objectives are the following?:

1. Be able to use built in contracts without namespace after Contracts included
2. Be able to include Contracts::Core & Contracts::Builtin, and still works like (1)
3. Be to reference built in contracts as something like Contracts::Maybe

[alex-fedorov]

@PikachuEXE Exactly!

[PikachuEXE]

Updated & squashed

In the next major bump (breaking),
Is that only Contracts::Builtin::Maybe is usable (or preferred)?

[waterlink]

No, we want to always have Builtin included in Contracts, so Contracts::Maybe is usable and preferred.

Extraction to Builtin is only done to make it possible to include Contracts::Builtin along with Contracts::Core when your code base don't have name clashes with built-in contracts.

Just include Contracts is a no go, because we define much more stuff than just built-in contracts, like: Engine and Support - which are pretty likely to clash.

[waterlink]

I think, we don't want to expose this information to users. We want them to still either:

• include Contracts::Core and use Contracts::Maybe (or C::Maybe)
• include Contracts::Core, Contracts::Builtin and use Maybe

So in TUTORIAL.md good changes are only for error messages and validator list

[waterlink]

If I think about validator list, it does not need to have Builtin:: in it too.

[waterlink]

@PikachuEXE Looks very good so far. Left some comments around Builtin:: usage in docs and code.

Ideally, since include Builtin have been added in Contracts, we don't need to use Builtin:: anywhere, nor our users need to know about Contracts::Builtin::*, they need to know only about include Contracts::Core and include Contracts::Builtin and about Contracts::ContractName and ContractName shortcut (in case Contracts::Builtin is included).

[PikachuEXE]

Most changes reverted except a few places
See my line note(s)

[waterlink]

LGTM

[waterlink]

@PikachuEXE Thanks!

[PikachuEXE]

@waterlink Do you know when will this & #198 be released?

[waterlink]

I will create a PR later today with changelog update and version bump. Then it is up to @egonSchiele to merge & release it to rubygems.

BTW, there is still need to add info on include Contracts::Builtin to TUTORIAL.md in Built-in contracts section.

[waterlink]

I will add this info later, no need to bother :)

[waterlink]

created