food_truck 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd099a583e774b65a4da7e95b2761a1936421aed671eb0bfa32efa28fc73dacd
+  data.tar.gz: 742a146fb686263044cf127db107df3e954bdef60d14a42b8b3a0d8f23f5efa6
+SHA512:
+  metadata.gz: 1c8331443590d3edcb78aaac9f43d05b9441fee4d26958829e137ab21996d47583a155cd0b29c149719e9aaa61728a5a641145f6a11e5ceb96548660bc65ef22
+  data.tar.gz: da2cde49548e0c58223a7676bacdddfa282e1cb02d11b821d539fcb04658b5ee3d07fb18e7a189dc2bf1dcacdf99043eb916d4c9a64046cc4d1205e9170faf06

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,138 @@
+AllCops:
+  TargetRubyVersion: 2.3.0
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/DocumentationMethod:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Don't leave calls to pry lying around.
+Lint/Debugger:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 150
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+# Only use braces if the function expects a hash argument. [different in Ruby 2.7+](https://blog.saeloun.com/2019/10/07/ruby-2-7-keyword-arguments-redesign.html)
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+# https://unix.stackexchange.com/a/18789
+Layout/TrailingBlankLines:
+  EnforcedStyle: final_newline
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+# Explicit, not redundant
+Style/RedundantReturn:
+  Enabled: false
+
+# Explicit, not redundant
+Style/RedundantSelf:
+  Enabled: false
+
+# Use of `&` with bracket access isn't what I'd call "readable".
+Style/SafeNavigation:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# TODO: File issue to ignore enums when using `EnforcedStyle: assign_inside_condition`.
+Style/ConditionalAssignment:
+  # EnforcedStyle: assign_inside_condition
+  # EnforcedStyle: assign_to_condition
+  Enabled: false
+
+Lint/HandleExceptions:
+  AllowComments: true
+
+# Lint/UnneededCopDisableDirective:
+#   Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: False
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+# [1]: https://medium.com/@nikgraf/why-you-should-enforce-dangling-commas-for-multiline-statements-d034c98e36f8

data/.solargraph.yml

@@ -0,0 +1,14 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+domains: []
+reporters:
+- typecheck
+- rubocop
+# - typecheck:strict
+require_paths: []
+max_files: 5000

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/.yardopts

@@ -0,0 +1,2 @@
+--charset utf-8
+--markup markdown

data/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+## master (unreleased)
+
+### 0.5.0 (2019-11-25)
+
+- Add [dry-rb/dry-inflector](https://github.com/dry-rb/dry-inflector) dependency.
+- Add `file_prefix` argument to `FoodTruck::Class` for String to prepend to the name of the generated file.
+
+## 0.4.0 (2019-11-21)
+
+### Added
+
+- Add `body` argument to `FoodTruck::Class` for code to be generated in the class body.
+
+## 0.3.0 (2019-11-21)
+
+### Added
+
+- Add the option to wrap generated code in modules.
+
+## 0.2.1 (2019-11-18)
+
+### Changed
+
+- Generate function body in `FoodTruck::Func.render`
+
+## 0.2.0 (2019-11-17)
+
+### Added
+
+- Generate Functions with Yard doc comments. (`FoodTruck::Func`)
+- Generate Function Parameters. (`FoodTruck::Param`)
+- Add support for generating classes with inheritance.
+- Add `food_truck` executable (WIP).
+
+### Changed
+
+- Rename `FoodTruck::Klass` to `FoodTruck::Class`
+- Rename `FoodTruck::Attribute` to `FoodTruck::Attr`
+
+### Fixed
+
+- Don't use Yard `@!attribute` tags unless the attributes are added dynamically (ex: Rails Models)
+
+## 0.1.0 (2019-11-15)
+
+### Added
+
+- Add changelog
+- Implement basic functionality.
+    - Generate Classes with Yard doc comments. (`FoodTruck::Klass`)
+    - Generate getters/setters (`attr_accessor`s) with Yard doc comments. (`FoodTruck::Attribute`)
+    - Load data from YAML/JSON files.

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in food_truck.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    food_truck (0.4.0)
+      dry-inflector (~> 0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.3.2)
+    dry-inflector (0.2.0)
+    json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    minitest-focus (1.1.2)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    tins (1.22.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls (~> 0.8.23)
+  food_truck!
+  minitest (~> 5.0)
+  minitest-focus (~> 1.1)
+  minitest-reporters (~> 1.4)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  simplecov
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Clay Dunston
+
+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,146 @@
+# FoodTruck
+
+[![Gem](https://img.shields.io/gem/v/food_truck)][rubygems]
+[![Build Status](https://travis-ci.org/tcd/food_truck.svg?branch=master)][travis-ci]
+[![Coverage Status](https://coveralls.io/repos/github/tcd/food_truck/badge.svg?branch=master)][coveralls-ci]
+[![Documentation](http://img.shields.io/badge/docs-rubydoc.info-blue.svg)][rubydoc-gem]
+
+[rubygems]: https://rubygems.org/gems/food_truck
+[travis-ci]: https://travis-ci.org/tcd/food_truck
+[coveralls-ci]: https://coveralls.io/github/tcd/food_truck?branch=master
+[rubydoc-gem]: https://www.rubydoc.info/gems/food_truck/0.5.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "food_truck"
+```
+
+And then execute:
+
+```ruby
+bundle
+```
+
+Or install it yourself as:
+
+```ruby
+gem install food_truck
+```
+
+## Usage
+
+### From the command line
+
+```yaml
+# person.yml
+---
+name: Human
+description: This class models a person.
+modules: [MilkyWay, Earth]
+parent: Mammal
+attrs:
+- name: Name
+  type: String
+- name: Age
+  description: Number of years the human has been alive.
+  type: Integer
+  read_only: true
+
+```
+
+```shell
+$ food_truck person.yml
+```
+
+### From Ruby code
+
+```ruby
+require "food_truck"
+
+data = {
+  name: "Human",
+  description: "This class models a person.",
+  modules: ["MilkyWay", "Earth"],
+  parent: "Mammal",
+  attrs: [
+    { name: "name", type: "String" },
+    { name: "age",  type: "Integer" read_only: true, description: "Number of years the human has been alive." },
+  ],
+}
+
+c = FoodTruck::Class.create(data)
+c.render()   #=> Returns the generated code as a string.
+c.generate() #=> Writes the generated code to a given folder, or the current directory if no argument is passed.
+```
+
+```ruby
+# human.rb
+module MilkyWay
+  module Earth
+    # This class models a person.
+    class Human < Mammal
+      # @return [String]
+      attr_accessor :name
+      # Number of years the human has been alive.
+      # @return [Integer]
+      attr_reader :age
+    end
+  end
+end
+```
+
+## Supported Arguments
+
+### `FoodTruck::Class`
+
+|      Name       |         Type         |                          Description                           |
+| --------------- | -------------------- | -------------------------------------------------------------- |
+| name (required) | `String`             | Name of the class.                                             |
+| description     | `String`             | Description of the class. [Markdown][markdown] is supported.   |
+| body            | `String`             | String to write into the body of the class.                    |
+| parent          | `String`             | Name of a class to inherit from. (Ex: `YourNewClass < Parent`) |
+| modules         | `Array<String>`      | List of modules to declare the class inside of                 |
+| attrs           | `Array<FoodTruck::Attr>` | An array of Attrs.                                             |
+
+### `FoodTruck::Attr`
+
+|      Name       |   Type    |                                                       Description                                                        |
+| --------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ |
+| name (required) | `String`  | Name of the attribute.                                                                                                   |
+| description     | `String`  | Description of the attribute. [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) is supported. |
+| type            | `String`  | [Type](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Declaring_Types) of the attribute.                     |
+| default         | `Any`     | Default value for the attribute; set in it's Class's `initialize` function.                                              |
+| read_only       | `Boolean` | If `true`, an `attr_reader` will be generated for the attribute instead of an `attr_accessor`.                           |
+
+### `FoodTruck::Func`
+
+|      Name       |         Type          |                                                Description                                                 |
+| --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------- |
+| name (required) | `String`              | Name of the function.                                                                                      |
+| description     | `String`              | Description of the function. [Markdown][markdown] is supported.                                            |
+| return_type     | `String`              | Return [type](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Declaring_Types) of the function. |
+| body            | `String`              | String to write into the body of the function.                                                             |
+| modules         | `Array<String>`       | List of modules to declare the function inside of                                                          |
+| params          | `Array<FoodTruck::Param>` | An array of Params.                                                                                        |
+
+### `FoodTruck::Param`
+
+|      Name       |   Type    |                                                     Description                                                      |
+| --------------- | --------- | -------------------------------------------------------------------------------------------------------------------- |
+| name (required) | `String`  | Name of the param.                                                                                                   |
+| description     | `String`  | Description of the param. [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) is supported. |
+| type            | `String`  | [Type](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Declaring_Types) of the param.                     |
+| default         | `Any`     | Default value for the param. Set `optional` as `true` for a default `nil` value.                                     |
+| optional        | `Boolean` | If `true`, the default value will be `nil`.                                                                          |
+| keyword         | `Boolean` | If `true`, the param will be generated as a [keyword argument](https://bugs.ruby-lang.org/issues/14183).             |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tcd/food_truck.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).