add -s --tail-slash options for gen cmd: default do not use trailing slash

Author: TTWShell

hobbit/bootstrap.py

@@ -69,8 +69,10 @@ def new(ctx, name, port, dist, template, force, celery):
 @click.option('-c', '--csv-path', required=False, type=click.Path(exists=True),
               callback=validate_csv_file,
               help='A csv file that defines some models.')
+@click.option('-s', '--tail-slash', default=False, is_flag=True,
+              help='Whether to use the trailing slash.')
 @click.pass_context
-def gen(ctx, name, template, dist, force, csv_path):
+def gen(ctx, name, template, dist, force, csv_path, tail_slash):
     """Generator new feature. Auto gen models/{name}.py, schemas/{name}.py,
     views/{name}.py, services/{name.py}, tests/test_{name}.py etc.
     """
@@ -88,6 +90,7 @@ def gen(ctx, name, template, dist, force, csv_path):
         'name': name,
         'module': module,
         'metadata': metadata,
+        'tail_slash': '/' if tail_slash else '',
     }
 
     render_project(dist, template)

hobbit/static/feature/rivendell/app/views/{{ name }}.py.jinja2

@@ -15,36 +15,36 @@ bp = Blueprint('{{ module }}', __name__)
 
 
 {% for model_name, Model in metadata.items() -%}
-@bp.route('/{{ Model.plural }}/', methods=['GET'])
+@bp.route('/{{ Model.plural }}{{ tail_slash }}', methods=['GET'])
 @use_kwargs(PageParams)
 def list_{{ Model.plural }}(page, page_size, order_by):
     page_ret = {{ model_name }}Service.list(page, page_size, order_by)
     return jsonify(schemas.paged_{{ Model.singular }}_schemas.dump(page_ret))
 
 
-@bp.route('/{{ Model.plural }}/', methods=['POST'])
+@bp.route('/{{ Model.plural }}{{ tail_slash }}', methods=['POST'])
 @use_kwargs(schemas.{{ Model.singular }}_schema)
 @transaction(db.session)
 def create_{{ Model.singular }}(**kwargs):
     instance = {{ model_name }}Service.create(**kwargs)
     return jsonify(schemas.{{ Model.singular }}_schema.dump(instance)), 201
 
 
-@bp.route('/{{ Model.plural }}/<int:pk>/', methods=['GET'])
+@bp.route('/{{ Model.plural }}/<int:pk>{{ tail_slash }}', methods=['GET'])
 def retrieve_{{ Model.singular }}(pk):
     instance = {{ model_name }}Service.get_or_404(pk)
     return jsonify(schemas.{{ Model.singular }}_schema.dump(instance))
 
 
-@bp.route('/{{ Model.plural }}/<int:pk>/', methods=['PUT'])
+@bp.route('/{{ Model.plural }}/<int:pk>{{ tail_slash }}', methods=['PUT'])
 @use_kwargs(schemas.{{ Model.singular }}_schema)
 @transaction(db.session)
 def update_{{ Model.singular }}(pk, **kwargs):
     instance = {{ model_name }}Service.update(pk, **kwargs)
     return jsonify(schemas.{{ Model.singular }}_schema.dump(instance))
 
 
-@bp.route('/{{ Model.plural }}/', methods=['DELETE'])
+@bp.route('/{{ Model.plural }}{{ tail_slash }}', methods=['DELETE'])
 @use_kwargs({'ids': DelimitedList(fields.Int())})
 @transaction(db.session)
 def delete_{{ Model.plural }}(ids):

hobbit/static/feature/rivendell/tests/test_{{ name }}.py.jinja2

@@ -21,12 +21,12 @@ class Test{{ model_name }}(BaseTest):
         return instance
 
     def test_list(self, client):
-        resp = client.get('/api/{{ Model.plural }}/')
+        resp = client.get('/api/{{ Model.plural }}{{ tail_slash }}')
         assert resp.status_code == 200
         assert set(resp.json.keys()) == {'items', 'page', 'page_size', 'total'}
 
     def test_retrieve(self, client, instance):
-        resp = client.get(f'/api/{{ Model.plural }}/{instance.id}/')
+        resp = client.get(f'/api/{{ Model.plural }}/{instance.id}{{ tail_slash }}')
         assert resp.status_code == 200
         assert set(resp.json.keys()) == {
             'created_at', 'id', 'updated_at'{%- for c in Model.columns -%}, '{{ c.field }}'{%- endfor -%}}
@@ -37,7 +37,7 @@ class Test{{ model_name }}(BaseTest):
             '{{ c.field }}': {{ c.test }}{%- if not loop.last -%}, {% endif -%}
             {%- endfor -%}
         }
-        resp = client.post('/api/{{ Model.plural }}/', json=payload)
+        resp = client.post('/api/{{ Model.plural }}{{ tail_slash }}', json=payload)
         assert resp.status_code == 201
         assert set(resp.json.keys()) == {
             'created_at', 'id', 'updated_at'{%- for c in Model.columns -%}, '{{ c.field }}'{%- endfor -%}}
@@ -50,15 +50,15 @@ class Test{{ model_name }}(BaseTest):
             '{{ c.field }}': {{ c.test }}{%- if not loop.last -%}, {% endif -%}
             {%- endfor -%}
         }
-        resp = client.put(f'/api/{{ Model.plural }}/{instance.id}/', json=payload)
+        resp = client.put(f'/api/{{ Model.plural }}/{instance.id}{{ tail_slash }}', json=payload)
         assert resp.status_code == 200
         assert set(resp.json.keys()) == {
             'created_at', 'id', 'updated_at'{%- for c in Model.columns -%}, '{{ c.field }}'{%- endfor -%}}
         for k, v in payload.items():
             assert resp.json[k] == v
 
     def test_delete(self, client, instance):
-        resp = client.delete(f'/api/{{ Model.plural }}/?ids={instance.id}')
+        resp = client.delete(f'/api/{{ Model.plural }}{{ tail_slash }}?ids={instance.id}')
         assert resp.status_code == 204
         assert {{ model_name }}.query.get(instance.id) is None
 {% if not loop.last %}

tests/test_hobbit.py

@@ -83,7 +83,7 @@ def csv_file(self, runner):
         assert result.exit_code == 0
 
     @pytest.mark.parametrize("gen_cmd", [
-        ['--echo', 'gen', '-n', 'user', '-t', 'rivendell'],
+        ['--echo', 'gen', '-n', 'user', '-t', 'rivendell', '-s'],
         ['--echo', 'gen', '-n', 'user', '-t', 'rivendell', '-f', '--csv-path',
          os.path.join(BaseTest.root_path, 'tests', 'models.csv')],
     ])