app_archetype 1.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a10af9366de2e0735df447d87d1cbe3660601702b038fffff206a7489687c70
+  data.tar.gz: 4708824cee9cb49c3731038b1f13dc88b61ecb732a1de7fe45d1a483a0e66120
+SHA512:
+  metadata.gz: 0bd5e63c6bdcdf49aa85266c2b63d09d5994113d192349051740829b3ce47d3727f7ee9455459aca5dec39b240d3d734df0c247dc8a8dfd4d6e3c0149d8cca07
+  data.tar.gz: a80ecdeaeb2e2ca8e2e91e6dbfbaaf78762cdd6eb8b3b3e94961696c3e3722f06170185b2404807a694db22e7be9e0737a44b886039b05a74077f307cf808612

data/.doxie.json

@@ -0,0 +1,25 @@
+{
+  "uploads": {
+     "yardoc": {
+        "source": "doc",
+        "target": {
+           "bucket": "docs-biggerconcept-com",
+           "key": "bitbucket.org/biggerconcept/app_archetype/doc"
+        }
+     },
+     "coverage": {
+        "source": "target/reports/coverage",
+        "target": {
+           "bucket": "docs-biggerconcept-com",
+           "key": "bitbucket.org/biggerconcept/app_archetype/coverage"
+        }
+     },
+     "critique": {
+        "source": "target/reports/critique",
+        "target": {
+           "bucket": "docs-biggerconcept-com",
+           "key": "bitbucket.org/biggerconcept/app_archetype/critique"
+        }
+     }
+  }
+}

data/.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# byebug history
+.byebug_history
+
+*.gem
+target/reports
+
+.DS_Store
+
+/doc/
+
+vendor/cache

data/.rubocop.yml

@@ -0,0 +1,35 @@
+---
+  AllCops:
+    TargetRubyVersion: 2.4
+  
+  Style/FrozenStringLiteralComment:
+    Enabled: false
+    
+  Style/SpecialGlobalVars:
+    Enabled: false
+
+  Style/MissingRespondToMissing:
+    Enabled: false
+  
+  Metrics/ClassLength:
+    Max: 200
+
+  Metrics/MethodLength:
+    Max: 20
+  
+  Metrics/AbcSize:
+    Max: 20
+  
+  Lint/AssignmentInCondition:
+    Enabled: false
+  
+  Metrics/BlockLength:
+    Exclude:
+      - 'app_archetype.gemspec'
+      - 'spec/**/*'
+
+  Gemspec/RequiredRubyVersion:
+    Enabled: false
+
+  Style/IfUnlessModifier:
+    Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.4

data/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+When contributing to App Archetype, please take note of the following requests.
+
+## Pull Request Process
+
+1. Before raising a pull request, please first discuss the change by raising an issue.
+2. Ensure any changes that change the behaviour or would be useful to implementers of this gem are documented within the README.md
+3. Increase the version number in any PR raised. The versioning scheme we use is [SemVer](https://semver.org/)
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing or otherwise unacceptable behaviour may be reported by contacting the project team. The project team will decide how to respond to any compliants.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org/version/1/4), version 1.4, available at http://contributor-covenant.org/version/1/4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,172 @@
+PATH
+  remote: .
+  specs:
+    app_archetype (1.2.3)
+      cli-format (~> 0.2)
+      highline (~> 2.0)
+      json (~> 2.3)
+      json-schema (~> 2.8)
+      jsonnet (~> 0.3.0)
+      logger (~> 1.4.2)
+      os (~> 1.1)
+      ostruct (~> 0.3)
+      ruby-handlebars (~> 0.4)
+      thor (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bump (0.9.0)
+    cli-format (0.2.0)
+      activesupport
+      text-table
+      zeitwerk
+    coderay (1.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.1.9)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    flay (2.12.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.4)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    highline (2.0.3)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    json (2.5.1)
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    jsonnet (0.3.0)
+      mini_portile2 (>= 2.2.0)
+    kwalify (0.7.2)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    logger (1.4.3)
+    method_source (1.0.0)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    os (1.1.1)
+    ostruct (0.3.3)
+    parallel (1.19.2)
+    parser (2.7.1.5)
+      ast (~> 2.4.1)
+    parslet (1.8.2)
+    path_expander (1.1.0)
+    private_gem (1.1.4)
+      bundler (> 1.7, < 3.0)
+      thor
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    psych (3.1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    reek (6.0.1)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (1.8.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.92.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.5.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    ruby-handlebars (0.4.0)
+      parslet (~> 1.6, >= 1.6.2)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.15.0)
+      sexp_processor (~> 4.9)
+    rubycritic (4.5.2)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (>= 2.0.0)
+      parser (>= 2.6.0)
+      rainbow (~> 3.0)
+      reek (~> 6.0, < 7.0)
+      ruby_parser (~> 3.8)
+      simplecov (>= 0.17.0)
+      tty-which (~> 0.4.0)
+      virtus (~> 1.0)
+    sexp_processor (4.15.1)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    text-table (1.2.4)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tty-which (0.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    yard (0.9.25)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  app_archetype!
+  bump (~> 0.9)
+  private_gem (~> 1.1)
+  pry (~> 0.13)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rubocop (~> 0.92)
+  rubycritic (~> 4.5)
+  simplecov (~> 0.19)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Andrew Bigger
+
+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,138 @@
+# App Archetype
+
+[![Ruby](https://github.com/andrewbigger/app_archetype/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/andrewbigger/app_archetype/actions/workflows/build.yml)
+
+Code project template renderer
+
+## Installation
+
+Add the following to your Gemfile
+
+```ruby
+gem 'app_archetype'
+```
+
+Or install the gem into your system:
+
+```bash
+gem install app_archetype
+```
+
+If installed as a system gem, you'll need to create a template directory and set it in your environment:
+
+```bash
+mkdir $HOME/Code/templates
+
+# zshrc
+echo '# App Archetype:' >> $HOME/.zshrc
+echo 'export ARCHETYPE_TEMPLATE_DIR="$HOME/Code/templates"' >> $HOME/.zshrc
+
+# bash
+echo '# App Archetype:' >> $HOME/.bashrc
+echo 'export ARCHETYPE_TEMPLATE_DIR="$HOME/Code/templates"' >> $HOME/.bashrc
+```
+
+Finally you'll need to set a editor environment variable for viewing files from app archetype:
+
+```bash
+# zshrc
+echo 'export ARCHETYPE_EDITOR="vi"' >> $HOME/.zshrc # sets vim as default editor
+
+# bash
+echo 'export ARCHETYPE_EDITOR="vi"' >> $HOME/.bashrc # sets vim as default editor
+```
+
+## Usage
+
+### Creating a template
+
+Templates are a collection of files in the template folder with a manifest. The structure is thus:
+
+```text
+ - $ARCHETYPE_TEMPLATE_DIR
+ | - my_template
+ | - | - template/
+ | - | - | - file.erb
+ | - | - | - file2.txt
+ | - | - manifest.json
+```
+
+Each template must include a manifest which has instructions necessary to render the template at run time. 
+
+To create a blank template run the new command with the relative (from your template directory) path to your new template. For example to create a ruby gem you might:
+
+```bash
+archetype new ruby/gem # creates a template at $ARCHETYPE_TEMPLATE_DIR/ruby/gem
+
+# or
+
+archetype new ruby_gem # creates a template at $ARCHETYPE_TEMPLATE_DIR/ruby_gem
+
+# or
+
+archetype new ruby/gem/on_rails # creates a template at $ARCHETYPE_TEMPLATE_DIR/ruby/gem/on_rails
+
+# etc.
+```
+
+#### Template Manifests
+
+A manifest has a name, version and set of variables. A sample manifest looks like this:
+
+```json
+{
+  "name": "my_template",
+  "version": "0.1.1",
+  "metadata": {
+    "app_archetype": {
+      "version": "0.1.2"
+    }
+  },
+  "variables": {
+    "foo": "bar",
+  }
+}
+```
+
+- `name` should be a unique name that identifies a manifest for you
+- `version` should be the version of the template
+- `metadata.app_archetype` is information about the manifest for the app archetype gem. `metadata.app_archetype.version` is required, and must be less than the version of the currently installed gem.
+- `variables` is a schemaless object that you may use to provide variables at render time
+
+##### Jsonnet support
+
+If plain ol' JSON isn't quite enough for you - manifests can also be expressed in jsonnet language. This permits you to use functions and objects to generate your template manifest. All manifest.json/manifest.jsonnet files will be parsed as you might expect.
+
+See [https://jsonnet.org/](https://jsonnet.org/) for more jsonnet documentation
+
+#### Template Files
+
+Templates are a collection of files within a folder. You may put any files you want in side the `/template` directory and when it comes time to use the template.
+
+ERB templates or handlebar templates will be rendered using the variables specified in the manifest.json. Anything that's not ERB or HBS will be copied across to the destination as is.
+
+You can include handlebars in file names, and like template files, the variables will be used to render the filenames.
+
+### Rendering a Template
+
+Adjust the template manifest to include the variables you want, and then run:
+
+```bash
+mkdir where_id_like_to_render
+cd where_id_like_to_render
+archetype render my_template
+```
+
+And the template will be rendered with the instructions in the manifest to the destinaton location as simple as that.
+
+### Listing Templates
+
+You can list the templates in your template directory at any time by running the list command:
+
+```bash
+archetype list
+```
+
+## Licence
+
+This gem is covered by the terms of the MIT licence. See LICENCE for more information