Merge branch 'release-0.2.0'

Author: Exadra37

.editorconfig

@@ -0,0 +1,12 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{md, markdown}]
+trim_trailing_whitespace = false

README.md

@@ -4,7 +4,7 @@ Scribes were an elite in ancient societies, highly regarded and holding special
 
 The motivation to create the Elixir Scribe tool was to encourage developers to write **Clean Code** in a **Clean Software Architecture**, to enable them to know in seconds all domains, resources, and actions used in a project, while reducing complexity and contributing for less technical debt.
 
-The Elixir Scribe tool enables developers craftsmanship and professionalism to reach new levels never imagined before or thought to not be easy to achieve.
+The Elixir Scribe tool enables developers to go from zero to hero in no time, while empowering their craftsmanship and professionalism to reach new levels never imagined before or thought to not be easy to achieve.
 
 Don't just be a Developer or Engineer, become a Scribe Developer and Engineer 🚀
 
@@ -22,6 +22,8 @@ Don't just be a Developer or Engineer, become a Scribe Developer and Engineer 
 * [Documentation](#documentation)
 * [Contributing](#contributing)
 * [Roadmap](#roadmap)
+  + [Generators](#elixir-scribe-generators)
+  + [Marketplace](#elixir-scribe-marketplace)
 
 
 ## Reduced Complexity Equals to Less Technical Debt
@@ -142,6 +144,7 @@ The main benefits of using the Elixir Scribe Tool to create and maintain Elixir
 * Quickly find and start debugging a bug because actions aren't entangled in a huge module with several resources for a domain (context). For example, if the bug is about creating a resource on a given domain, it's straightforward to know where to start due to the folder structure.
 * Each resource on a domain has a public API to avoid direct access to the underlying implementation of each resource. This removes cross-domain boundary calls into the internals of each resource implementation, preventing the coupling of domains, which is a significant source of technical debt and complexity in a codebase. The Resource public API MUST be used not only from other domains but also from within the domain itself. This will allow the internals of a resource in a domain to change as needed, provided that we do not affect the public API for it.
 * The folder structure is documentation that never lies about what domains (contexts), resources, and actions are available in your project, whether huge or small.
+* Enables easier migration from a monolithic to a micro-services architecture when the need arises.
 
 [TOC](#toc)
 
@@ -164,6 +167,8 @@ end
 
 ## Quickstart
 
+> **IMPORTANT:** Not merged yet to the main branch.
+
 Let's create a fictitious Online Shop to exemplify how to use the Elixir Scribe tool:
 
 ```
@@ -212,20 +217,33 @@ The Elixir Scribe tool is highly opinionated, therefore I ask you to first [open
 
 ## Roadmap
 
-The roadmap is extensive and due to the continuous high efforts and commitments to develop and maintain everything I may only provide some of the generators to Sponsors and/or as Pro versions that will require a paid license.
+The roadmap is extensive and due to the continuous high efforts and commitments to develop and maintain everything I may only provide some of the features to Sponsors and/or as Pro versions that will require a paid license.
 
 ### Elixir Scribe Generators
 
-- [ ] Mix task: `scribe.gen.domain`
-- [ ] Mix task: `scribe.gen.html`
-- [ ] Mix task: `scribe.gen.live`
-- [ ] Mix task: `scribe.gen.home`
+This generators provide developers with the tools to go from zero to hero in no time, while following a Clean Software Architecture that encourages Clean Code when building their Apps or APIs.
+
+#### Typed Contracts
+
+- [x] - Typed Contract is a struct with type specs to guarantee data shape correctness at runtime.
+
+
+#### Mix Tasks
+
+- [ ] `scribe.gen.domain`
+- [ ] `scribe.gen.html`
+- [ ] `scribe.gen.live`
+- [ ] `scribe.gen.template`
+  * Generates a template to be customized for the project.
+    + The template includes the code generated by all Elixir Scribe generators, e.g. `scribe.gen.*`.
+  * The customized template can also be uploaded to the marketplace as freebie or one to be sold under a paid license.
+- [ ] `scribe.gen.home`
   * Removes current default Home page.
   * Adds new Home page with links to each Domain and Resource.
   * Optimizes default HTMl layout and components for a more clean and usable UI:
     + Table headers in Bold
     + Highlight links in blue, not in bold (black).
-- [ ] Mix task: `scribe.gen.ci` 
+- [ ] `scribe.gen.ci` 
   * Generates a CI file for Github or Gitlab with at least the following:
     + `mix format --dry-run --check-formatted`
     + `mix deps.unlock --check-unused`
@@ -235,9 +253,9 @@ The roadmap is extensive and due to the continuous high efforts and commitments
     + `mix credo`
     + `mix doctor`
     + `mix test --cover`
-- [ ] Mix task: `scribe.gen.project`
+- [ ] `scribe.gen.project`
   * Generates all Domains, Resources and Actions from an Elixir Scribe spec module `%ElixirScribe.ProjectSpecs{}`. 
-- [ ] Mix task: `scribe.gen.api`
+- [ ] `scribe.gen.api`
   * Adds a dynamic API key (only valid for one request).
   * Adds support for fingerprinting the mobile and web app.
   * Adds support to collect metrics.
@@ -247,22 +265,29 @@ The roadmap is extensive and due to the continuous high efforts and commitments
     + To control feature flags.
     + To enable a kill-switch to force upgrade to a new version.
     + To dynamically conduct experiments with user experience, A/B testing.
-- [ ] Mix task: `scribe.gen.auth`
+- [ ] `scribe.gen.auth`
   * Adds enhanced User Authentication:
     + fingerprinting of the client enabled by default 
     + enabled by default to all pages, except Home page.
-- [ ] Mix task: `scribe.gen.oauth`
+- [ ] `scribe.gen.oauth`
   * Adds enhanced OAuth for popular providers:
     + fingerprinting of the client enabled by default 
     + enabled by default to all pages, except Home page.
-- [ ] Mix task: `scribe.gen.native`
+- [ ] `scribe.gen.native`
   * Enables the project to be built for Desktop, Android and Apple.
   * Elixir libraries to build for native targets:
     + [LiveView Native](https://github.com/liveview-native)
     + [Elixir Desktop](https://github.com/elixir-desktop/desktop)
     + [ExTauri](https://github.com/Exadra37/ex_tauri)
-- [ ] Mix task: `scribe.gen.static`
+- [ ] `scribe.gen.static`
   * Generates a static website from a current project.
-- [ ] Mix task: `scribe.gen.deploy`
+- [ ] `scribe.gen.deploy`
   * Adds easy deployment to popular hosting providers.
-- [ ] Mix task: `scribe.gen.admin`
+- [ ] `scribe.gen.admin`
+
+
+### Elixir Scribe Marketplace
+
+- [ ] Website to sell free and paid licenses for Elixir Scribe templates.
+  * The marketplace will support as vendors anyone that builds quality templates with the Elixir Scribe tool.
+  * Vendors of paid licenses will pay a fee for each sale, plus payment fees. It will be all very transparent, no hidden fees. 

lib/docs/modules/behaviours/persona.ex

@@ -0,0 +1,21 @@
+defmodule Persona do
+  @moduledoc false
+
+  require PersonaValidator
+
+  @keys %{
+    required: [:name, :email],
+    optional: [role: nil]
+  }
+
+  use ElixirScribe.Behaviour.TypedContract, keys: @keys
+
+  @impl true
+  def type_spec() do
+    schema(%__MODULE__{
+      name: is_binary() |> spec(),
+      email: PersonaValidator.corporate_email?() |> spec(),
+      role: PersonaValidator.role?() |> spec()
+    })
+  end
+end

lib/docs/modules/behaviours/persona_validator.ex

@@ -0,0 +1,31 @@
+defmodule PersonaValidator do
+  @moduledoc false
+
+  # A very simplistic set o validations used by the docs usage examples.
+
+  @email_providers ["gmail.com", "yahoo.com", "hotmail.com"]
+  def corporate_email?(email) when is_binary(email) do
+    case String.split(email, "@", trim: true) do
+      [_one_part] ->
+        false
+
+      [_, email_provider] when email_provider not in @email_providers ->
+        true
+
+      _ ->
+        false
+    end
+  end
+
+  def corporate_email?(_email), do: false
+
+  # The role is optional, thus we return true
+  def role?(role) when is_nil(role), do: true
+
+  def role?(role) when is_binary(role) do
+    role = role |> String.trim()
+    String.length(role) >= 3
+  end
+
+  def role?(_age), do: false
+end

lib/elixir_scribe.ex

@@ -1,18 +1,3 @@
 defmodule ElixirScribe do
-  @moduledoc """
-  Documentation for `ElixirScribe`.
-  """
-
-  @doc """
-  Hello world.
-
-  ## Examples
-
-      iex> ElixirScribe.hello()
-      :world
-
-  """
-  def hello do
-    :world
-  end
+  @moduledoc false
 end