praxis 2.0.pre.9 → 2.0.pre.10

data/tasks/thor/templates/generator/example_app/design/v1/media_types/user.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module V1
+  module MediaTypes
+    class User < Praxis::MediaType
+      identifier 'application/json'
+
+      domain_model 'V1::Resources::User'
+      description 'A user in the system'
+
+      attributes do
+        attribute :uid, String
+        attribute :uuid, String
+        attribute :email, String
+        attribute :first_name, String
+        attribute :last_name, String
+        attribute :state, String, values: %i[pending active]
+      end
+
+      default_fieldset do
+        attribute :uid
+      end
+    end
+  end
+end
+

data/tasks/thor/templates/generator/example_app/spec/helpers/database_helper.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+
+class DatabaseHelper
+  # Simple DB seeding to avoid bringing in other gems like FactoryGirl etc.
+  # This does the job for an example seeder
+  def self.seed!
+    user_data = [
+      {id: 11, first_name: 'Peter', last_name: 'Praxis', uuid: 'deadbeef'},
+      {id: 12, first_name: 'Alice', last_name: 'Trellis', uuid: 'beefdead'}
+    ]
+    (100..199).each do |i|
+      user_data.push id: i, first_name: "User-#{i}", last_name: "Last-#{i}", uuid: SecureRandom.hex(16).to_s
+    end
+    user_data.each_with_index do |data, i|
+      ::User.create(**data)
+    end
+  end
+end

data/tasks/thor/templates/generator/example_app/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+Bundler.setup :default, :test
+Bundler.require :default, :test
+ENV['RACK_ENV'] = 'test'
+
+begin
+  APP=Rack::Builder.parse_file(File.expand_path('../config.ru', __dir__)).first
+rescue => e
+  puts "Application failed to initialize:"
+  raise e
+  exit 1
+end
+
+# Migrate and seed the DB (only an empty in-memory DB)
+require_relative 'helpers/database_helper'
+ActiveRecord::Migration.verbose = false # ?? does not seem to work like this
+ActiveRecord::Tasks::DatabaseTasks.migrate
+DatabaseHelper.seed!
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+
+  config.before(:suite) do
+    # Praxis::Blueprint.caching_enabled = true
+    DatabaseCleaner.strategy = :transaction
+  end
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+
+  # config.before(:each) do
+  #   Praxis::Blueprint.cache = Hash.new do |hash, key|
+  #     hash[key] = Hash.new
+  #   end
+  # end
+  
+  def app
+    APP
+  end
+end
+

data/tasks/thor/templates/generator/example_app/spec/v1/controllers/users_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+
+require 'spec_helper'
+describe V1::Controllers::Users do
+  before do
+    header 'X-API-Version', '1'
+  end
+
+  let(:response) { subject; last_response }
+  let(:json_payload) { JSON.dump(payload) }
+  let(:parsed_body) { JSON.parse(response.body, symbolize_names: true) }
+
+  context 'index' do
+    let(:filters_q) { '' }
+    let(:fields_q) { 'uid,uuid' }
+    let(:query_string) do
+      "filters=#{CGI.escape(filters_q)}&fields=#{CGI.escape(fields_q)}"
+    end
+    subject { get "/users?#{query_string}" }
+
+    context 'without filters' do
+      it { expect(response.status).to eq 200 }
+      it 'returns all users' do
+        expect(parsed_body.size).to eq(2+100)
+      end
+    end
+    context 'using filters' do
+      let(:filters_q) { 'first_name=Peter' }
+      it 'returns only peter' do
+        expect(parsed_body.size).to eq(1)
+        # Peter has id 11 from our seeds
+        expect(parsed_body.map{|u| u[:uid]}).to eq(['11'])
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.9
+  version: 2.0.pre.10
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -73,20 +73,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: praxis-blueprints
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: attributor
   requirement: !ruby/object:Gem::Requirement
@@ -406,98 +392,13 @@ files:
 - Rakefile
 - TODO.md
 - bin/praxis
-- lib/api_browser/.bowerrc
-- lib/api_browser/.editorconfig
-- lib/api_browser/Gruntfile.js
-- lib/api_browser/app/index.html
-- lib/api_browser/app/js/app.js
-- lib/api_browser/app/js/controllers/action.js
-- lib/api_browser/app/js/controllers/controller.js
-- lib/api_browser/app/js/controllers/menu.js
-- lib/api_browser/app/js/controllers/trait.js
-- lib/api_browser/app/js/controllers/type.js
-- lib/api_browser/app/js/directives/attribute_description.js
-- lib/api_browser/app/js/directives/attribute_table.js
-- lib/api_browser/app/js/directives/conditional_requirements.js
-- lib/api_browser/app/js/directives/fixed_if_fits.js
-- lib/api_browser/app/js/directives/highlight.js
-- lib/api_browser/app/js/directives/menu_item.js
-- lib/api_browser/app/js/directives/no_container.js
-- lib/api_browser/app/js/directives/readable_list.js
-- lib/api_browser/app/js/directives/request_examples.js
-- lib/api_browser/app/js/directives/type_placeholder.js
-- lib/api_browser/app/js/directives/url.js
-- lib/api_browser/app/js/factories/Configuration.js
-- lib/api_browser/app/js/factories/Documentation.js
-- lib/api_browser/app/js/factories/Example.js
-- lib/api_browser/app/js/factories/PageInfo.js
-- lib/api_browser/app/js/factories/normalize_attributes.js
-- lib/api_browser/app/js/factories/prepare_template.js
-- lib/api_browser/app/js/factories/template_for.js
-- lib/api_browser/app/js/filters/attribute_name.js
-- lib/api_browser/app/js/filters/friendly_json.js
-- lib/api_browser/app/js/filters/has_requirement.js
-- lib/api_browser/app/js/filters/header_info.js
-- lib/api_browser/app/js/filters/is_empty.js
-- lib/api_browser/app/js/filters/markdown.js
-- lib/api_browser/app/js/filters/resource_name.js
-- lib/api_browser/app/js/filters/tag_requirement.js
-- lib/api_browser/app/sass/modules/_body.scss
-- lib/api_browser/app/sass/modules/_cloke.scss
-- lib/api_browser/app/sass/modules/_header.scss
-- lib/api_browser/app/sass/modules/_nav.scss
-- lib/api_browser/app/sass/modules/_sidebar.scss
-- lib/api_browser/app/sass/modules/_switch.scss
-- lib/api_browser/app/sass/modules/_table.scss
-- lib/api_browser/app/sass/praxis.scss
-- lib/api_browser/app/sass/variables/_bootstrap-variables.scss
-- lib/api_browser/app/views/action.html
-- lib/api_browser/app/views/builtin/field-selector.html
-- lib/api_browser/app/views/controller.html
-- lib/api_browser/app/views/directives/attribute_description.html
-- lib/api_browser/app/views/directives/attribute_description/default.html
-- lib/api_browser/app/views/directives/attribute_description/example.html
-- lib/api_browser/app/views/directives/attribute_description/headers.html
-- lib/api_browser/app/views/directives/attribute_description/member_options.html
-- lib/api_browser/app/views/directives/attribute_description/values.html
-- lib/api_browser/app/views/directives/attribute_table.html
-- lib/api_browser/app/views/directives/menu_item.html
-- lib/api_browser/app/views/directives/url.html
-- lib/api_browser/app/views/examples/general.html
-- lib/api_browser/app/views/home.html
-- lib/api_browser/app/views/layout.html
-- lib/api_browser/app/views/menu.html
-- lib/api_browser/app/views/navbar.html
-- lib/api_browser/app/views/trait.html
-- lib/api_browser/app/views/type.html
-- lib/api_browser/app/views/type/details.html
-- lib/api_browser/app/views/types/embedded/array.html
-- lib/api_browser/app/views/types/embedded/default.html
-- lib/api_browser/app/views/types/embedded/field-selector.html
-- lib/api_browser/app/views/types/embedded/links.html
-- lib/api_browser/app/views/types/embedded/requirements.html
-- lib/api_browser/app/views/types/embedded/single_req.html
-- lib/api_browser/app/views/types/embedded/struct.html
-- lib/api_browser/app/views/types/label/link.html
-- lib/api_browser/app/views/types/label/primitive.html
-- lib/api_browser/app/views/types/label/primitive_collection.html
-- lib/api_browser/app/views/types/label/type.html
-- lib/api_browser/app/views/types/label/type_collection.html
-- lib/api_browser/app/views/types/main/array.html
-- lib/api_browser/app/views/types/main/default.html
-- lib/api_browser/app/views/types/main/hash.html
-- lib/api_browser/app/views/types/standalone/array.html
-- lib/api_browser/app/views/types/standalone/default.html
-- lib/api_browser/app/views/types/standalone/struct.html
-- lib/api_browser/bower_template.json
-- lib/api_browser/package-lock.json
-- lib/api_browser/package.json
 - lib/praxis.rb
 - lib/praxis/action_definition.rb
 - lib/praxis/action_definition/headers_dsl_compiler.rb
 - lib/praxis/api_definition.rb
 - lib/praxis/api_general_info.rb
 - lib/praxis/application.rb
+- lib/praxis/blueprint.rb
 - lib/praxis/bootloader.rb
 - lib/praxis/bootloader_stages/environment.rb
 - lib/praxis/bootloader_stages/file_loader.rb
@@ -511,22 +412,22 @@ files:
 - lib/praxis/callbacks.rb
 - lib/praxis/collection.rb
 - lib/praxis/config.rb
+- lib/praxis/config_hash.rb
 - lib/praxis/controller.rb
 - lib/praxis/dispatcher.rb
-- lib/praxis/docs/generator.rb
-- lib/praxis/docs/link_builder.rb
+- lib/praxis/docs/open_api/info_object.rb
+- lib/praxis/docs/open_api/media_type_object.rb
+- lib/praxis/docs/open_api/operation_object.rb
+- lib/praxis/docs/open_api/parameter_object.rb
+- lib/praxis/docs/open_api/paths_object.rb
+- lib/praxis/docs/open_api/request_body_object.rb
+- lib/praxis/docs/open_api/response_object.rb
+- lib/praxis/docs/open_api/responses_object.rb
+- lib/praxis/docs/open_api/schema_object.rb
+- lib/praxis/docs/open_api/server_object.rb
+- lib/praxis/docs/open_api/tag_object.rb
 - lib/praxis/docs/open_api_generator.rb
-- lib/praxis/docs/openapi/info_object.rb
-- lib/praxis/docs/openapi/media_type_object.rb
-- lib/praxis/docs/openapi/operation_object.rb
-- lib/praxis/docs/openapi/parameter_object.rb
-- lib/praxis/docs/openapi/paths_object.rb
-- lib/praxis/docs/openapi/request_body_object.rb
-- lib/praxis/docs/openapi/response_object.rb
-- lib/praxis/docs/openapi/responses_object.rb
-- lib/praxis/docs/openapi/schema_object.rb
-- lib/praxis/docs/openapi/server_object.rb
-- lib/praxis/docs/openapi/tag_object.rb
+- lib/praxis/endpoint_definition.rb
 - lib/praxis/error_handler.rb
 - lib/praxis/exception.rb
 - lib/praxis/exceptions/config.rb
@@ -561,12 +462,13 @@ files:
 - lib/praxis/extensions/rails_compat.rb
 - lib/praxis/extensions/rails_compat/request_methods.rb
 - lib/praxis/extensions/rendering.rb
+- lib/praxis/field_expander.rb
 - lib/praxis/file_group.rb
+- lib/praxis/finalizable.rb
 - lib/praxis/handlers/json.rb
 - lib/praxis/handlers/plain.rb
 - lib/praxis/handlers/www_form.rb
 - lib/praxis/handlers/xml-sample.rb
-- lib/praxis/links.rb
 - lib/praxis/mapper/active_model_compat.rb
 - lib/praxis/mapper/resource.rb
 - lib/praxis/mapper/selector_generator.rb
@@ -582,6 +484,7 @@ files:
 - lib/praxis/plugins/mapper_plugin.rb
 - lib/praxis/plugins/pagination_plugin.rb
 - lib/praxis/plugins/rails_plugin.rb
+- lib/praxis/renderer.rb
 - lib/praxis/request.rb
 - lib/praxis/request_stages/action.rb
 - lib/praxis/request_stages/load_request.rb
@@ -614,30 +517,26 @@ files:
 - lib/praxis/trait.rb
 - lib/praxis/types/fuzzy_hash.rb
 - lib/praxis/types/media_type_common.rb
-- lib/praxis/types/multipart.rb
 - lib/praxis/types/multipart_array.rb
 - lib/praxis/types/multipart_array/part_definition.rb
 - lib/praxis/validation_handler.rb
 - lib/praxis/version.rb
 - praxis.gemspec
-- spec/api_browser/directives/type_placeholder_spec.js
-- spec/api_browser/factories/configuration_spec.js
-- spec/api_browser/factories/documentation_spec.js
-- spec/api_browser/factories/normalize_attributes_spec.js
-- spec/api_browser/factories/template_for_spec.js
-- spec/api_browser/filters/attribute_name_spec.js
 - spec/functional_spec.rb
 - spec/praxis/action_definition_spec.rb
 - spec/praxis/api_definition_spec.rb
 - spec/praxis/api_general_info_spec.rb
 - spec/praxis/api_resource_spec.rb
 - spec/praxis/application_spec.rb
+- spec/praxis/blueprint_spec.rb
 - spec/praxis/bootloader_spec.rb
 - spec/praxis/callbacks_spec.rb
 - spec/praxis/collection_spec.rb
+- spec/praxis/config_hash_spec.rb
 - spec/praxis/config_spec.rb
 - spec/praxis/controller_spec.rb
 - spec/praxis/dispatcher_spec.rb
+- spec/praxis/endpoint_definition_spec.rb
 - spec/praxis/extensions/attribute_filtering/active_record_filter_query_builder_spec.rb
 - spec/praxis/extensions/attribute_filtering/filter_tree_node_spec.rb
 - spec/praxis/extensions/attribute_filtering/filtering_params_spec.rb
@@ -649,6 +548,7 @@ files:
 - spec/praxis/extensions/rendering_spec.rb
 - spec/praxis/extensions/support/spec_resources_active_model.rb
 - spec/praxis/extensions/support/spec_resources_sequel.rb
+- spec/praxis/field_expander_spec.rb
 - spec/praxis/file_group_spec.rb
 - spec/praxis/handlers/json_spec.rb
 - spec/praxis/mapper/resource_spec.rb
@@ -659,11 +559,11 @@ files:
 - spec/praxis/multipart/parser_spec.rb
 - spec/praxis/notifications_spec.rb
 - spec/praxis/plugin_concern_spec.rb
+- spec/praxis/renderer_spec.rb
 - spec/praxis/request_spec.rb
 - spec/praxis/request_stages/action_spec.rb
 - spec/praxis/request_stages/request_stage_spec.rb
 - spec/praxis/request_stages/validate_spec.rb
-- spec/praxis/resource_definition_spec.rb
 - spec/praxis/response_definition_spec.rb
 - spec/praxis/response_spec.rb
 - spec/praxis/responses/internal_server_error_spec.rb
@@ -676,7 +576,6 @@ files:
 - spec/praxis/types/fuzzy_hash_spec.rb
 - spec/praxis/types/multipart_array/part_definition_spec.rb
 - spec/praxis/types/multipart_array_spec.rb
-- spec/praxis/types/multipart_spec.rb
 - spec/spec_app/app/concerns/authenticated.rb
 - spec/spec_app/app/concerns/basic_api.rb
 - spec/spec_app/app/concerns/log_wrapper.rb
@@ -706,18 +605,17 @@ files:
 - spec/spec_helper.rb
 - spec/support/be_deep_equal_matcher.rb
 - spec/support/spec_authorization_plugin.rb
+- spec/support/spec_blueprints.rb
 - spec/support/spec_complex_authentication_plugin.rb
+- spec/support/spec_endpoint_definitions.rb
 - spec/support/spec_media_types.rb
-- spec/support/spec_resource_definitions.rb
 - spec/support/spec_resources.rb
 - spec/support/spec_simple_authentication_plugin.rb
 - tasks/loader.thor
 - tasks/thor/app.rb
 - tasks/thor/example.rb
 - tasks/thor/templates/generator/empty_app/.gitignore
-- tasks/thor/templates/generator/empty_app/.rspec
 - tasks/thor/templates/generator/empty_app/Gemfile
-- tasks/thor/templates/generator/empty_app/Guardfile
 - tasks/thor/templates/generator/empty_app/README.md
 - tasks/thor/templates/generator/empty_app/Rakefile
 - tasks/thor/templates/generator/empty_app/app/models/.empty_directory
@@ -726,19 +624,35 @@ files:
 - tasks/thor/templates/generator/empty_app/app/responses/.gitkeep
 - tasks/thor/templates/generator/empty_app/app/v1/controllers/.empty_directory
 - tasks/thor/templates/generator/empty_app/app/v1/controllers/.gitkeep
+- tasks/thor/templates/generator/empty_app/app/v1/resources/.empty_directory
+- tasks/thor/templates/generator/empty_app/app/v1/resources/.gitkeep
 - tasks/thor/templates/generator/empty_app/config.ru
 - tasks/thor/templates/generator/empty_app/config/environment.rb
-- tasks/thor/templates/generator/empty_app/config/rainbows.rb
+- tasks/thor/templates/generator/empty_app/config/initializers/.empty_directory
+- tasks/thor/templates/generator/empty_app/config/initializers/.gitkeep
 - tasks/thor/templates/generator/empty_app/design/api.rb
-- tasks/thor/templates/generator/empty_app/design/response_templates/.empty_directory
-- tasks/thor/templates/generator/empty_app/design/response_templates/.gitkeep
+- tasks/thor/templates/generator/empty_app/design/v1/endpoints/.empty_directory
+- tasks/thor/templates/generator/empty_app/design/v1/endpoints/.gitkeep
 - tasks/thor/templates/generator/empty_app/design/v1/media_types/.empty_directory
 - tasks/thor/templates/generator/empty_app/design/v1/media_types/.gitkeep
-- tasks/thor/templates/generator/empty_app/design/v1/resources/.empty_directory
-- tasks/thor/templates/generator/empty_app/design/v1/resources/.gitkeep
-- tasks/thor/templates/generator/empty_app/docs/app.js
-- tasks/thor/templates/generator/empty_app/docs/styles.scss
+- tasks/thor/templates/generator/empty_app/docs/.empty_directory
+- tasks/thor/templates/generator/empty_app/docs/.gitkeep
 - tasks/thor/templates/generator/empty_app/spec/spec_helper.rb
+- tasks/thor/templates/generator/example_app/.gitignore
+- tasks/thor/templates/generator/example_app/Gemfile
+- tasks/thor/templates/generator/example_app/Rakefile
+- tasks/thor/templates/generator/example_app/app/models/user.rb
+- tasks/thor/templates/generator/example_app/app/v1/controllers/users.rb
+- tasks/thor/templates/generator/example_app/app/v1/resources/user.rb
+- tasks/thor/templates/generator/example_app/config.ru
+- tasks/thor/templates/generator/example_app/config/environment.rb
+- tasks/thor/templates/generator/example_app/db/migrate/20201010101010_create_users_table.rb
+- tasks/thor/templates/generator/example_app/design/api.rb
+- tasks/thor/templates/generator/example_app/design/v1/endpoints/users.rb
+- tasks/thor/templates/generator/example_app/design/v1/media_types/user.rb
+- tasks/thor/templates/generator/example_app/spec/helpers/database_helper.rb
+- tasks/thor/templates/generator/example_app/spec/spec_helper.rb
+- tasks/thor/templates/generator/example_app/spec/v1/controllers/users_spec.rb
 homepage: https://github.com/praxis/praxis
 licenses:
 - MIT

data/lib/api_browser/.bowerrc

@@ -1,3 +0,0 @@
-{
-    "directory": "app/bower_components"
-}