platformer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d08454048761151bd69db6c4bac1ae1bc9f585457ae60932727b9303ce77f29c
+  data.tar.gz: b51d1482188431343d0f0c205aaad7b8441bb9ae72adc390c8bec36085f8b4b1
+SHA512:
+  metadata.gz: 67202605ef5f1a84093aa54a1bb53045442f1463ec45796206a27759ee3bebe008e7eedec7585e98ddacafe19178f5c4a647f759e188c6ea58f37a4828d62bb1
+  data.tar.gz: b21a32e98c5219df3b2503c8dd209d8571e47d710cc7390fc82b61121e5455ff9c200192dde3e5565acbadaf6f71d02f46ed533d7c9e915dd8d492b671cea0dd

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 (2023-06-23)
+
+
+### Features
+
+* most basic proof of concept ([c746441](https://github.com/craigulliott/platformer/commit/c746441f2042c290f2b582c0b29f086154df08a9))

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 craigulliott@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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Craig Ulliott
+
+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,63 @@
+# Platformer
+
+Compose a SaaS platform through configuration.
+
+[![Gem Version](https://badge.fury.io/rb/platformer.svg)](https://badge.fury.io/rb/platformer)
+[![Specs](https://github.com/craigulliott/platformer/actions/workflows/specs.yml/badge.svg)](https://github.com/craigulliott/platformer/actions/workflows/specs.yml)
+[![Types](https://github.com/craigulliott/platformer/actions/workflows/types.yml/badge.svg)](https://github.com/craigulliott/platformer/actions/workflows/types.yml)
+[![Coding Style](https://github.com/craigulliott/platformer/actions/workflows/linter.yml/badge.svg)](https://github.com/craigulliott/platformer/actions/workflows/linter.yml)
+
+## Key Features
+
+* Build and deploy a platform through configuration rather than code
+* Ability to express all real world business logic for most businesses
+* Automatically generates all database migrations
+* Automatically generate documentation for your platform
+* Opinionated - GraphQL, oAuth2, Application and Database Level Data Validations
+* Performant and reliable, even at large scale
+* Includes Cloudformation Scripts to launch appropriate scalable infrastructure
+
+## Installation
+
+Install the gem by executing:
+
+    $ gem install platformer
+
+Create your new platform:
+
+    $ platformer create my_platform_name
+
+## Getting Started
+
+Todo
+
+
+## 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.
+
+We use [Conventional Commit Messages](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13).
+
+Code should be linted and formatted according to [Ruby Standard](https://github.com/standardrb/standard).
+
+Publishing is automated via github actions and Googles [Release Please](https://github.com/google-github-actions/release-please-action) github action
+
+We prefer using squash-merges when merging pull requests because it helps keep a linear git history and allows more fine grained control of commit messages which get sent to release-please and ultimately show up in the changelog.
+
+Type checking is enabled for this project. You can find the corresponding `rbs` files in the sig folder.
+
+Install types for the packages used in development (such as `rspec`) by running
+
+    $ rbs collection install
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/craigulliott/platformer. 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/craigulliott/platformer/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This software is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Platformer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/craigulliott/platformer/blob/master/CODE_OF_CONDUCT.md).

data/lib/platformer/composer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Platformer
+  class Composer
+    class ClassDoesNotUseDSLComposeError < StandardError
+    end
+
+    # when provided with a class which has DSLCompose added to it, such
+    # as ApplicationModel, this method will execute the provided block
+    # once for every child class of the provided class. A common use of this
+    # method would be to find all classes of a particular type (such as
+    # models or callback definitions) and dynamically create something
+    # for each of them
+    def self.for_each_child_class klass, &block
+      unless klass.respond_to? :dsls
+        raise ClassDoesNotUseDSLCompose
+      end
+      if block
+        klass.dsls.executions_by_class.each do |k, dsl|
+          yield k
+        end
+      else
+        warn "no block provided"
+      end
+    end
+
+    def self.for_each klass, dsl_name, &block
+      # todo
+    end
+  end
+end

data/lib/platformer/composers/create_active_models.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Platformer
+  module Composers
+    class CreateActiveModels < Composer
+      # Dynamically create ActiveRecord classes to represent each
+      # of our model definitions.
+      #
+      # For example, if we have have created a UserModel and an
+      # OrganizationModel, then this composer will generate a `User`
+      # and an `Organization` class, these new classes will extend
+      # ActiveRecord::Base
+      for_each_child_class ApplicationModel do |klass|
+        # for a model class with an optional namespace, such as
+        # Users::UserModel, returns an array ['Users', 'User']
+        class_address = klass.name.gsub(/Model\Z/, "").split("::")
+        # the last item in the address is the new class name
+        class_name = class_address.pop
+        # where is this new class being created
+        namespace = if class_address.any?
+          # any remaining items describe the namespace
+          class_address.join("::").constantize
+        else
+          # Object is the top most namespace
+          Object
+        end
+
+        new_class = Class.new(ActiveRecord::Base)
+        namespace.const_set class_name, new_class
+      end
+
+      for_each ApplicationModel, :string_field do |klass, name|
+      end
+    end
+  end
+end

data/lib/platformer/dsls/models/fields/string_field.rb

@@ -0,0 +1,58 @@
+module Platformer
+  module DSLs
+    module Models
+      module Fields
+        module StringField
+          def self.included klass
+            klass.define_dsl :string_field do
+              description "Add a string field to this model."
+
+              # the name of the field
+              requires :name, :symbol do
+                description "The name of your field"
+                validate_format(/\A[a-z]+(_[a-z]+)*\Z/)
+                validate_length minimum: 1, maximum: 63
+
+                # can not be called "type" because it is reserved by STI models
+                validate_not_in [
+                  # stage is used by state machines
+                  :stage,
+                  # timestamped booleans
+                  :undeleted,
+                  :deleted_at,
+                  # timestamped booleans
+                  # :un*,
+                  # :*_at,
+                  :stage,
+                  # Reserved for the primary key
+                  :id,
+                  # Reserved for foreign keys
+                  # *_id,
+                  # Specifies that the model uses Single Table Inheritance.
+                  :type,
+                  # Automatically gets set to the current date and time when the record is first created.
+                  :created_at,
+                  # Automatically gets set to the current date and time whenever the record is created or updated.
+                  :updated_at
+                  # Adds optimistic locking to a model.
+                  # lock_version,
+                  # # Stores the type for polymorphic associations.
+                  # *_type,
+                  # # Used to cache the number of belonging objects on associations. For example, a comments_count column in an Article class that has many instances of Comment will cache the number of existent comments for each article.
+                  # (table_name)_count,
+                ]
+              end
+
+              add_method :case_insensitive
+              add_method :required
+              add_method :unique
+              add_method :description do
+                requires :description, :string
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/platformer/version.rb

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

data/lib/platformer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "dsl_compose"
+require "active_record"
+
+require "platformer/version"
+
+Dir[File.expand_path "lib/platformer/dsls/**/*.rb"].each do |f|
+  require_relative f
+end
+
+Dir[File.expand_path "app/**/*.rb"].each do |f|
+  require_relative f
+end
+
+require "platformer/composer"
+
+Dir[File.expand_path "lib/platformer/composers/**/*.rb"].each do |f|
+  require_relative f
+end
+
+module Platformer
+  class Error < StandardError
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: platformer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Craig Ulliott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dsl_compose
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Easily create highly scalable and performant SaaS platforms through configuration
+email:
+- craigulliott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/platformer.rb
+- lib/platformer/composer.rb
+- lib/platformer/composers/create_active_models.rb
+- lib/platformer/dsls/models/fields/string_field.rb
+- lib/platformer/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/craigulliott/platformer/
+  changelog_uri: https://github.com/craigulliott/platformer/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Create SaaS Platforms through configuration
+test_files: []