ronin-app 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e807463567097ddf828ab12bc5c0d75fc1ea05d7c7c755d67e6550d6cd368776
+  data.tar.gz: 54f0e5ae8cbb25d1749e6896060d1345ffdc3086085ea7317d4f7fe8e56543a1
+SHA512:
+  metadata.gz: 3e7ec51601d1f88f7993157c6b9c0bf315e8cfda3b6daf8eb43da9239f4e0177fb94ce156601de05c41d2a4595a48697dc4aec96de9647dc804dd068e8e559f7
+  data.tar.gz: 6efcab13cc6137d69581a0cc4f8e9b79eb97082e5add7b1f8f68a7861646daee311ad1d3246d1478e2d683a864554167dd76f73db4a8a9ee16e91d25a4be1f9f

data/.dockerignore

@@ -0,0 +1,3 @@
+.bundle/config
+Gemfile.lock
+vendor/bundle

data/.document

@@ -0,0 +1,6 @@
+app.rb
+lib/**/*.rb
+workers/**/*.rb
+- 
+ChangeLog.md
+COPYING.txt

data/.env.dev

@@ -0,0 +1 @@
+DATABASE_URL=sqlite3:db/dev.sqlite3

data/.github/workflows/ruby.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.1'
+          - '3.2'
+          - '3.3'
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: |
+          sudo apt update -y && \
+          sudo apt install -y --no-install-recommends --no-install-suggests libsqlite3-dev
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.gitignore

@@ -0,0 +1,16 @@
+/Gemfile.lock
+/coverage
+/doc
+/log
+/man/*.1
+/tmp
+/vendor/bundle
+/.bundle
+/.yardoc
+.DS_Store
+*.db
+*.log
+*.swp
+*~
+dump.rdb
+/db

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin-app specific exceptions
+#
+
+# dry-types constructor requires an explicit block with one block argument
+Style/SymbolProc:
+  Exclude:
+    - 'lib/ronin/app/types.rb'
+
+# $redis global variable is fine.
+Style/GlobalVars:
+  Exclude:
+    - 'config/redis.rb'
+
+# in lib/schema we use Dry::Schema::Params() style class-methods
+Naming/MethodName:
+  Exclude:
+    - 'lib/ronin/app/schemas/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Ronin::App Documentation' --protected

data/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+* Typo, spelling mistake, and CSS fixes are welcomed and appreciated.
+* Please develop against [Ruby] 3.1.x.
+* Please make sure new code passes `bundle exec rubocop` style checking.
+* Please write tests for all new code and make sure they pass.
+
+## What is NOT allowed
+
+* HAML, Slim, and other HTML templating engines are NOT allowed.
+  Please use regular [ERB] that renders [HTML5].
+* SASS/SCSS are NOT allowed. Only use vanilla [CSS4].
+* JavaScript frameworks are NOT allowed. This means NO React, Angular, Svelte,
+  etc. Only use [vanilla ES6 JavaScript][vanilla.js].
+* JavaScript packers/compilers are NOT allowed. This means no Babel or Webpack. 
+  All JavaScript must be loaded directly or via [import maps].
+* No external assets. All images, CSS, and JavaScript must be vendored in
+  `public/stylesheets/` or `public/javascript/` so that the app can be used
+  offline.
+* No Rails dependencies. While we do use [ActiveRecord] for [ronin-db],
+  I prefer to avoid using [activesupport] or any other Rails dependencies to
+  keep the codebase as lightweight and simple as possible. Instead look for
+  [dry-rb] or [sinatra-] alternatives.
+
+[Ruby]: https://www.ruby-lang.org/
+[ERB]: https://docs.ruby-lang.org/en/3.1/ERB.html
+[HTML5]: https://dev.w3.org/html5/spec-LC/
+[CSS4]: https://developer.mozilla.org/en-US/docs/Web/CSS
+[vanilla.js]: http://vanilla-js.com/
+[import maps]: https://github.com/WICG/import-maps#readme
+[ActiveRecord]: https://guides.rubyonrails.org/active_record_basics.html
+[activesupport]: https://www.rubydoc.info/gems/activesupport
+[dry-rb]: https://www.dry-rb.org/
+[sinatra-]: https://rubygems.org/search?query=sinatra-