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

data/tasks/thor/templates/generator/empty_app/.gitignore

@@ -1,5 +1,4 @@
 log
 .bundle
-api_docs
 docs/output
 docs/json

data/tasks/thor/templates/generator/empty_app/Gemfile

@@ -1,29 +1,13 @@
 source "https://rubygems.org"
 
-gem 'praxis', github: 'praxis/praxis'
-gem 'attributor', github: 'praxis/attributor'
-gem 'praxis-blueprints', github: 'praxis/praxis-blueprints'
-
-gem 'rainbows', require: false
-gem 'rake'
-gem 'pry'
-gem 'pry-byebug'
+gem 'praxis'
+gem 'rack'
 
 group :development, :test do
-  gem "rack-test", :require => "rack/test"
+  gem 'rack-test'
   gem "rspec" # needed for rake task
-  gem 'rspec-its'
-  gem 'rspec-collection_matchers'
-
-  gem 'foreman', :require => false
-
-  platform :mri_19, :mri_20 do
-    gem 'shotgun', :require => false
-    gem "guard"
-    gem "guard-rspec"
-  end
-end
 
-platform :jruby do
-  gem 'jruby-openssl'
-end
+  gem 'rake'
+  gem 'pry'
+  gem 'pry-byebug'
+end

data/tasks/thor/templates/generator/empty_app/README.md

@@ -1,4 +1,4 @@
-Sample Blog Application
+Example Application
 =======================
 
 

data/tasks/thor/templates/generator/empty_app/Rakefile

@@ -5,21 +5,12 @@ Bundler.require(:default, ENV['RACK_ENV'])
 
 require 'praxis/tasks'
 
-task :default => :spec
-
-# load up the Praxis app
-task :environment do
-  Praxis::Application.instance.setup
-end
-
-desc "console"
-task :console => :environment do
-  require 'pry'
-  require 'pry-byebug'
-  pry
-end
+desc "Drop into a console with the full application loaded"
+task console: 'praxis:console'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 Dir["lib/tasks/**/*.rake"].each { |ext| load ext }
+
+task :default => :spec

data/tasks/thor/templates/generator/empty_app/config/environment.rb

@@ -1,17 +1,25 @@
-#
-#Praxis::Application.instance.layout do
-#  map :initializers, 'config/initializers/**/*'
-#  map :lib, 'lib/**/*'
-#  map :design, 'design/' do
-#    map :api, 'api.rb'
-#    map :media_types, '**/media_types/**/*'
-#    map :resources, '**/resources/**/*'
-#  end
-#  map :app, 'app/' do
-#    map :models, 'models/**/*'
-#    map :controllers, '**/controllers/**/*'
-#    map :responses, '**/responses/**/*'
-#  end
-#end
-#
-#
+
+Praxis::Application.configure do |application|
+  # This is a commented out copy of the default Praxis layout
+  # This example app follows the standard practices, so there is no reason to override it
+  # If we wanted to organize the structure and ordering of files, we can uncomment the layout
+  # and define it at our own leisure
+  # application.layout do
+  #   map :initializers, 'config/initializers/**/*'
+  #   map :lib, 'lib/**/*'
+  #   map :design, 'design/' do
+  #     map :api, 'api.rb'
+  #     map :helpers, '**/helpers/**/*'
+  #     map :types, '**/types/**/*'
+  #     map :media_types, '**/media_types/**/*'
+  #     map :endpoints, '**/endpoints/**/*'
+  #   end
+  #   map :app, 'app/' do
+  #     map :models, 'models/**/*'
+  #     map :responses, '**/responses/**/*'
+  #     map :exceptions, '**/exceptions/**/*'
+  #     map :resources, '**/resources/**/*'
+  #     map :controllers, '**/controllers/**/*'
+  #   end
+  # end
+end

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

@@ -4,15 +4,20 @@ Bundler.require :default, :test
 RSpec.configure do |config|
   config.include Rack::Test::Methods
 
-  config.before(:suite) do
-    Praxis::Blueprint.caching_enabled = true
-    Praxis::Application.instance.setup
-  end
+  # config.before(:suite) do
+  #   Praxis::Blueprint.caching_enabled = true
+  # end
 
-  config.before(:each) do
-    Praxis::Blueprint.cache = Hash.new do |hash, key|
-      hash[key] = Hash.new
-    end
-  end
+  # config.before(:each) do
+  #   Praxis::Blueprint.cache = Hash.new do |hash, key|
+  #     hash[key] = Hash.new
+  #   end
+  # end
+end
 
+def app
+  Rack::Builder.parse_file(File.expand_path('../config.ru', __dir__)).first
+rescue => e
+  puts "Application failed to initialize: #{e}"
+  exit 1
 end

data/tasks/thor/templates/generator/example_app/.gitignore

@@ -0,0 +1 @@
+development.sqlite3

data/tasks/thor/templates/generator/example_app/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gem 'praxis'
+gem 'rack'
+gem 'sqlite3'
+gem 'activerecord'
+gem 'puma' # A much better web server than the default webrick
+gem 'parslet' # For field selection extension
+gem 'link_header' # For pagination extensions
+
+group :development, :test do
+  gem 'rake'
+  gem 'rack-test'
+  gem "rspec" # needed for rake task
+  gem 'database_cleaner' # For transactional DB tests
+
+  gem 'pry'
+  gem 'pry-byebug'
+end

data/tasks/thor/templates/generator/example_app/Rakefile

@@ -0,0 +1,54 @@
+ENV['RACK_ENV'] = 'development'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'praxis'
+require 'praxis/tasks'
+
+# Setup Activerecord migrations
+require 'active_record'
+db_dir = File.expand_path('../db', __dir__)
+ActiveRecord::Tasks::DatabaseTasks.env = ENV['RACK_ENV']
+ActiveRecord::Tasks::DatabaseTasks.db_dir = db_dir
+ActiveRecord::Tasks::DatabaseTasks.migrations_paths = File.join(db_dir, 'migrate')
+
+# Redefine the environment task to load our app
+Rake::Task['praxis:environment'].clear
+namespace :praxis do
+  task :environment do
+    FULL_APP = Rack::Builder.parse_file(File.expand_path('./config.ru', __dir__)).first
+  end
+end
+
+Dir['lib/tasks/**/*.rake'].each { |ext| load ext }
+
+# Inlined basic DB tasks to avoid packaging more files and directories
+namespace :db do
+  require 'active_record/tasks/database_tasks'
+
+  desc 'migrate'
+  task migrate: 'praxis:environment' do
+    ActiveRecord::Tasks::DatabaseTasks.migrate
+    puts "Database migrated."
+  end
+
+  desc 'seed with example data'
+  task seed: 'praxis:environment' do
+    require_relative 'spec/helpers/database_helper'
+    DatabaseHelper.seed!
+  end
+
+  desc 'drops current database'
+  task drop: 'praxis:environment' do
+    db_file = "development.sqlite3"
+    puts "Removing file #{db_file}"
+    `rm -f #{db_file}`
+  end
+
+  desc 'creates configured database'
+  task create: 'praxis:environment' do
+    puts "Creating file development.sqlite3"
+    ActiveRecord::Base.connection.execute("SELECT 1")
+  end
+end
+

data/tasks/thor/templates/generator/example_app/app/models/user.rb

@@ -0,0 +1,6 @@
+
+class User < ActiveRecord::Base
+  # So it can be used in all the automatic query/filtering extensions
+  include Praxis::Mapper::ActiveModelCompat
+
+end

data/tasks/thor/templates/generator/example_app/app/v1/controllers/users.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module V1
+  module Controllers
+    class Users
+      include Praxis::Controller
+      include Praxis::Extensions::Rendering
+      
+      implements V1::Endpoints::Users
+
+      def index
+        objects = build_query(::User)
+        display(objects)
+      end
+    end
+  end
+end

data/tasks/thor/templates/generator/example_app/app/v1/resources/user.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module V1
+  module Resources
+    class User < Praxis::Mapper::Resource
+      model ::User
+
+      # Mappings for the allowed filterd
+      filters_mapping(
+        'email': 'email',
+        'first_name': 'first_name',        
+        # Complex (convoluted?) mapping of state, just to show how we can modify and adapt the values/fields/operators
+        'state': lambda do |spec|
+          case spec[:value].to_s
+          when 'pending' # Pending users do not have a uuid
+            { name: :uuid, value: nil, op: spec[:op] }
+          when 'active' # Active users do not have a uuid (so "flip" the original equality condition)
+            opposite_op = spec[:op] == '=' ? '!=' : '='
+            { name: :uuid, value: nil, op: opposite_op }
+          else
+            raise "Cannot filter users by state #{spec[:value]}"
+          end
+        end,
+      )
+
+      # Example of a property that depends on a differently named DB field
+      property :uid, dependencies: %i[id]
+      # To compute the full_name (method below) we need to load first and last names from the DB
+      property :full_name, dependencies: %i[first_name last_name]
+
+      def uid
+        id # underlying id field of the model
+      end
+
+      # Computed attribute: if uuid nil, user in in a pending stat, else active
+      def state 
+        self.uuid.nil? ? 'pending' : 'active'
+      end
+
+      # Computed attribute the combines first and last
+      def full_name
+        [first_name, last_name].join(' ')
+      end
+    end
+  end
+end

data/tasks/thor/templates/generator/example_app/config.ru

@@ -0,0 +1,31 @@
+# -p 8888
+
+ENV['RACK_ENV'] ||= 'development'
+Bundler.setup(:default, ENV['RACK_ENV'])
+Bundler.require(:default, ENV['RACK_ENV'])
+
+# Want to take advantage of some of the Praxis' extensions for:
+# API field selection (a la GraphQL) - for querying and rendering
+# API filtering extensions (to add "where clauses") in listings
+# Views and partial rendering (for ActiveRecord models)
+
+require 'praxis/plugins/mapper_plugin'
+require 'praxis/mapper/active_model_compat'
+require 'praxis/extensions/field_selection'
+require 'praxis/plugins/pagination_plugin'
+
+# Start the sqlite DB
+case ENV['RACK_ENV']
+when 'test'
+  ActiveRecord::Base.establish_connection(
+    adapter:  'sqlite3',
+    database: ':memory:'
+  )
+else
+  ActiveRecord::Base.establish_connection(
+    adapter:  'sqlite3',
+    database: "development.sqlite3"
+  )
+end
+
+run Praxis::Application.instance.setup

data/tasks/thor/templates/generator/example_app/config/environment.rb

@@ -0,0 +1,40 @@
+
+Praxis::Application.configure do |application|
+
+  # Configure the Mapper plugin (if we want to use all the filtering/field_selection extensions)
+  application.bootloader.use Praxis::Plugins::MapperPlugin
+  # Cconfigure the Pagination plugin (if we want to use all the pagination/ordering extensions)
+  application.bootloader.use Praxis::Plugins::PaginationPlugin, {
+    # max_items: 500,  # Unlimited by default,
+    # default_page_size: 100,
+    # paging_default_mode: {by: :id},
+    # disallow_paging_by_default: false,
+    # disallow_cursor_by_default: false,
+    # sorting: {
+    #   enforce_all_fields: true
+    # }
+  }
+  
+  # This is a commented out copy of the default Praxis layout
+  # This example app follows the standard practices, so there is no reason to override it
+  # If we wanted to organize the structure and ordering of files, we can uncomment the layout
+  # and define it at our own leisure
+  # application.layout do
+  #   map :initializers, 'config/initializers/**/*'
+  #   map :lib, 'lib/**/*'
+  #   map :design, 'design/' do
+  #     map :api, 'api.rb'
+  #     map :helpers, '**/helpers/**/*'
+  #     map :types, '**/types/**/*'
+  #     map :media_types, '**/media_types/**/*'
+  #     map :endpoints, '**/endpoints/**/*'
+  #   end
+  #   map :app, 'app/' do
+  #     map :models, 'models/**/*'
+  #     map :responses, '**/responses/**/*'
+  #     map :exceptions, '**/exceptions/**/*'
+  #     map :resources, '**/resources/**/*'
+  #     map :controllers, '**/controllers/**/*'
+  #   end
+  # end
+end

data/tasks/thor/templates/generator/example_app/db/migrate/20201010101010_create_users_table.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateUsersTable < ActiveRecord::Migration[5.2]
+  def change
+    create_table :users do |table|
+      table.column :uuid, :integer
+      table.column :first_name, :string
+      table.column :last_name, :string
+    end
+  end
+end

data/tasks/thor/templates/generator/example_app/design/api.rb

@@ -0,0 +1,18 @@
+# Use this file to define your overall api behavior, response templates and traits.
+Praxis::ApiDefinition.define do
+  info do
+    name 'example'
+    title 'Example API'
+
+    # Attributes for OpenAPI docs
+    termsOfService 'https://mysitehere.com'
+    contact name: 'API Info', email: 'info@mysitehere.com'
+  end
+  
+  # Trait that when included will require a Bearer authorization header to be passed in.
+  trait :authorized do
+    headers do
+      key "Authorization", String, regexp: /^.*Bearer\s/, required: true
+    end
+  end
+end

data/tasks/thor/templates/generator/example_app/design/v1/endpoints/users.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module V1
+  module Endpoints
+    class Users
+      include Praxis::EndpointDefinition
+      # include AuthenticatedEndpoint
+
+      media_type MediaTypes::User
+      version '1'
+
+      description 'Endpoints that allow the listing and manipulation of users'
+
+      action :index do
+        description 'List users'
+        routing { get '' }
+        params do
+          attribute :fields, Praxis::Types::FieldSelector.for(MediaTypes::User),
+                    description: 'Fields with which to render the result.'
+          attribute :filters, Praxis::Types::FilteringParams.for(MediaTypes::User) do
+            filter 'state', using: ['=', '!=']
+            filter 'first_name', using: ['=', '!='], fuzzy: true
+            filter 'last_name', using: ['=', '!='], fuzzy: true
+          end
+          attribute :pagination, Praxis::Types::PaginationParams.for(MediaTypes::User) do
+            by_fields :uid, :first_name, :last_name
+          end
+          attribute :order, Praxis::Extensions::Pagination::OrderingParams.for(MediaTypes::User) do
+            by_fields :uid, :last_name, :first_name
+          end          
+        end
+        response :ok, media_type: Praxis::Collection.of(MediaTypes::User)
+      end
+    end
+  end
+end
+