shaf 0.1.0.beta

data/lib/shaf/spec/serializer_spec.rb

@@ -0,0 +1,24 @@
+module Shaf
+  module Spec
+    class SerializerSpec < Minitest::Spec
+      include Minitest::Hooks
+      include PayloadUtils
+
+      TRANSACTION_OPTIONS = {
+        rollback: :always,
+        savepoint: true,
+        auto_savepoint: true
+      }.freeze
+
+      register_spec_type self do |desc, args|
+        next true if desc.to_s =~ /Serializer$/
+        next unless args && args.is_a?(Hash)
+        args[:type]&.to_s == 'serializer'
+      end
+
+      around do |&block|
+        DB.transaction(TRANSACTION_OPTIONS) { super(&block) }
+      end
+    end
+  end
+end

data/lib/shaf/tasks.rb

@@ -0,0 +1,4 @@
+require 'shaf/settings'
+require 'shaf/tasks/db'
+require 'shaf/tasks/test'
+

data/lib/shaf/tasks/db.rb

@@ -0,0 +1,61 @@
+namespace :db do
+  desc "Prints current schema version"
+  task :version do
+    require 'config/database'
+    if DB.tables.include?(:schema_migrations)
+      migration = DB[:schema_migrations].order(:filename).last
+      filename = migration && migration[:filename]
+      if match = /(\d*)_(.*).rb/.match(filename)
+        puts "Schema version: #{match[1]} (#{match[2]})"
+      else
+        puts "No migration found"
+      end
+    else
+      puts "No schema_info table"
+    end
+  end
+
+  desc "Prints all schema versions"
+  task :versions do
+    require 'config/database'
+    if DB.tables.include?(:schema_migrations)
+      DB[:schema_migrations].each do |migration|
+        filename = migration && migration[:filename]
+        if match = /(\d*)_(.*).rb/.match(filename)
+          puts "#{match[1]}: #{match[2]}"
+        end
+      end
+    else
+      puts "No schema_info table"
+    end
+  end
+
+  desc "Run migrations"
+  task :migrate, [:version] do |t, args|
+    require 'config/database'
+    Sequel.extension :migration
+    if args[:version]
+      puts "Migrating to version #{args[:version]}"
+      Sequel::Migrator.run(DB, MIGRATIONS_DIR, target: args[:version].to_i)
+    else
+      puts "Migrating to latest"
+      Sequel::Migrator.run(DB, MIGRATIONS_DIR)
+    end
+  end
+
+  desc "Perform rollback to specified target or full rollback as default"
+  task :rollback, :target do |t, args|
+    args.with_defaults(target: 0)
+    require 'config/database'
+    Sequel.extension :migration
+    Sequel::Migrator.run(DB, MIGRATIONS_DIR, target: args[:target].to_i)
+  end
+
+  Rake::Task["db:migrate"].enhance do
+    Rake::Task["db:version"].invoke
+  end
+
+  Rake::Task["db:rollback"].enhance do
+    Rake::Task["db:version"].invoke
+  end
+end

data/lib/shaf/tasks/test.rb

@@ -0,0 +1,43 @@
+require 'rake/testtask'
+
+namespace :test do |ns|
+  Rake::TestTask.new(:integration) do |t|
+    t.libs = %w(. api spec)
+    t.pattern = "spec/integration/**/*_spec.rb"
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:models) do |t|
+    t.libs = %w(. api spec)
+    t.pattern = "spec/models/**/*_spec.rb"
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:serializers) do |t|
+    t.libs = %w(. api spec)
+    t.pattern = "spec/serializers/**/*_spec.rb"
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:lib) do |t|
+    t.libs = %w(. api spec)
+    t.pattern = "spec/lib/**/*_spec.rb"
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:all) do |t|
+    t.libs = %w(. api spec)
+    t.pattern = [
+      "spec/lib/**/*_spec.rb",
+      "spec/models/**/*_spec.rb",
+      "spec/serializers/**/*_spec.rb",
+      "spec/integration/**/*_spec.rb"
+    ]
+    t.verbose = true
+  end
+
+end
+
+desc "Run all tests"
+task test: 'test:all'
+

data/lib/shaf/utils.rb

@@ -0,0 +1,53 @@
+module Shaf
+  module Utils
+    class ProjectRootNotFound < StandardError; end
+
+    def self.pluralize(noun)
+      noun + 's' #FIXME
+    end
+
+    def project_root
+      dir = Dir.pwd
+      20.times do
+        if is_project_root?(dir)
+          return dir
+        elsif dir == '/'
+          break
+        end
+        dir = File.expand_path("..", dir)
+      end
+    end
+
+    def project_root!
+      project_root or raise ProjectRootNotFound
+    end
+
+    def is_project_root?(dir)
+      File.exist? File.expand_path(".shaf", dir)
+    end
+
+    def in_project_root?
+      is_project_root?(Dir.pwd)
+    end
+
+    def in_project_root
+      return unless block_given?
+      Dir.chdir(project_root!) do
+        $:.unshift Dir.pwd
+        yield
+      end
+    end
+
+    def bootstrap
+      in_project_root do
+        ENV['RACK_ENV'] ||= 'development'
+        require 'config/bootstrap'
+        yield if block_given?
+      end
+    end
+
+    def pluralize(noun)
+      Utils::pluralize(noun)
+    end
+  end
+end

data/lib/shaf/version.rb

@@ -0,0 +1,3 @@
+module Shaf
+  VERSION = "0.1.0.beta"
+end

data/templates/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :development)
+$:.unshift __dir__
+require 'shaf/tasks'
+require 'shaf/settings'
+require 'shaf/api_doc'
+
+Shaf::ApiDoc::Task.new do |api_doc|
+  api_doc.source_dir = File.join(%w(api serializers))
+  api_doc.html_output_dir = File.join(Shaf::Settings.public_folder, "doc")
+  api_doc.yaml_output_dir = Shaf::Settings.documents_dir || "doc/api"
+end

data/templates/api/controllers/base_controller.rb

@@ -0,0 +1,57 @@
+class BaseController < Sinatra::Base
+
+  include Shaf::Errors
+
+  configure do
+    disable :static
+    enable :logging
+    enable :method_override
+    mime_type :hal, 'application/hal+json'
+    set :views, VIEWS_DIR
+    set :static, !production?
+    set :public_folder, ASSETS_DIR
+    disable :dump_errors
+    set :show_exceptions, :after_handler
+  end
+
+  use Rack::Deflater
+  register(*Shaf.extensions)
+  helpers(*Shaf.helpers)
+
+  def self.inherited(controller)
+    super
+    Shaf::App.use controller
+  end
+
+  def log
+    $logger
+  end
+
+  before do
+    log.info "Processing: #{request.request_method} #{request.path_info}"
+    log.debug "Payload: #{payload || 'empty'}"
+  end
+
+  error StandardError do
+    err = env['sinatra.error']
+    log.error err.message
+    err.backtrace.each(&log.method(:error))
+
+    api_error = to_api_error(err)
+
+    respond_with api_error,
+      status: api_error.http_status,
+      serializer: ErrorSerializer
+  end
+
+  def to_api_error(err)
+    case err
+    when Shaf::Authorize::PolicyViolationError
+      ForbiddenError.new
+    when ServerError
+      err
+    else
+      ServerError.new(err.message)
+    end
+  end
+end

data/templates/api/controllers/docs_controller.rb

@@ -0,0 +1,16 @@
+class DocsController < BaseController
+
+  register_uri :doc_curie,    '/doc/:resource/rels/{rel}'
+
+  get '/doc/:resource/rels/:rel' do
+    doc.link(params[:rel])
+  end
+
+  get '/doc/:resource' do
+    doc.to_s
+  end
+
+  def doc
+    Shaf::DocModel.find!(params[:resource])
+  end
+end

data/templates/api/controllers/root_controller.rb

@@ -0,0 +1,8 @@
+class RootController < BaseController
+
+  register_uri :root,    '/'
+
+  get '/' do
+    respond_with nil, serializer: RootSerializer
+  end
+end

data/templates/api/serializers/error_serializer.rb

@@ -0,0 +1,10 @@
+class ErrorSerializer
+  extend HALPresenter
+
+  model Shaf::Errors::ServerError
+
+  attribute :title
+  attribute :code
+  attribute :message
+
+end

data/templates/api/serializers/form_serializer.rb

@@ -0,0 +1,42 @@
+require 'shaf/formable'
+
+class FormSerializer
+  extend HALPresenter
+
+  model Shaf::Formable::Form
+
+  attribute :method do
+    (options[:method] || resource&.method || 'POST').to_s.upcase
+  end
+
+  attribute :name do
+    options[:name] || resource&.name
+  end
+
+  attribute :title do
+    options[:title] || resource&.title
+  end
+
+  attribute :href do
+    options[:href] || resource&.href
+  end
+
+  attribute :type do
+    options[:type] || resource&.type
+  end
+
+  link :self do
+    options[:self_link] || resource&.self_link
+  end
+
+  post_serialize do |hash|
+    fields = resource&.fields
+    break if fields.nil? || fields.empty?
+    hash[:fields] = fields.map do |field|
+      { name: field.name, type: field.type }.tap do |f|
+        f[:value] = field.value if field.has_value?
+        f[:label] = field.label
+      end
+    end
+  end
+end

data/templates/api/serializers/root_serializer.rb

@@ -0,0 +1,16 @@
+class RootSerializer
+  extend HALPresenter
+  extend Shaf::UriHelper
+
+  # Auto generated doc:  
+  # Link to the root resource. All clients should fetch this resource
+  # when starting to interact with this API.  
+  # Method: GET  
+  # Example:
+  # ```
+  # curl -H "Accept: application/json" \
+  #      -H "Authorization: abcdef" \
+  #      /
+  #```
+  link :self, root_uri
+end

data/templates/config.ru

@@ -0,0 +1,4 @@
+$:.unshift __dir__
+require 'config/bootstrap'
+
+run Shaf::App.instance

data/templates/config/bootstrap.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, ENV['RACK_ENV'])
+
+$logger = nil
+require 'shaf/settings'
+require 'config/constants'
+require 'config/database'
+require 'config/initializers'
+require 'api/controllers/base_controller'
+require 'config/directories'
+require 'config/helpers'

data/templates/config/constants.rb

@@ -0,0 +1,5 @@
+APP_ROOT = File.expand_path('../', __dir__)
+APP_DIR = File.expand_path('api', APP_ROOT)
+VIEWS_DIR = File.join(APP_ROOT, Shaf::Settings.views_folder)
+ASSETS_DIR = File.join(APP_ROOT, Shaf::Settings.public_folder)
+PAGINATION_PER_PAGE = Shaf::Settings.paginate_per_page || 25

data/templates/config/customize.rb

@@ -0,0 +1,3 @@
+# Load your custom commands and generators in this file. E.g.
+# require 'lib/my_command'
+# require 'lib/my_generator'

data/templates/config/database.rb

@@ -0,0 +1,40 @@
+require 'sinatra/base'
+require 'sequel'
+require 'config/constants'
+require 'fileutils'
+
+CONFIG = {
+
+  production: {
+    adapter: 'postgres',
+    host: ENV['SHAF_DB_HOST'],
+    database: ENV['SHAF_DB_NAME'],
+    user: ENV['SHAF_DB_USER'],
+    password: ENV['SHAF_DB_PASS']
+  }.freeze,
+
+  development: {
+    adapter: 'sqlite',
+    database: File.join(APP_ROOT, 'db', 'development.sqlite3'),
+  }.freeze,
+
+  test: {
+    adapter: 'sqlite',
+    database: File.join(APP_ROOT, 'db', 'test.sqlite3'),
+  }.freeze
+
+}.freeze
+
+
+env = Sinatra::Application.settings.environment
+
+unless CONFIG[env]
+  STDERR.puts "No Database config for environment '#{env}'"
+  exit 1
+end
+
+MIGRATIONS_DIR = File.join(APP_ROOT, Shaf::Settings.migrations_dir)
+FileUtils.mkdir_p(MIGRATIONS_DIR) unless Dir.exist?(MIGRATIONS_DIR)
+
+DB = Sequel.connect(CONFIG[env])
+

data/templates/config/directories.rb

@@ -0,0 +1,32 @@
+require 'config/constants'
+
+$:.unshift APP_DIR
+
+def sort_files(files)
+  files.sort_by do |file|
+    case file
+    when /\Alib/
+      0
+    when /\Ahelpers/
+      1
+    when /\Amodels/
+      2
+    when /\Acontrollers/
+      3
+    when /\Apolicies/
+      4
+    else
+      5
+    end
+  end
+end
+
+Dir.chdir(APP_DIR) do
+  files = Dir[File.join('**', '*.rb')]
+  sort_files(files).each do |file|
+    # load all files with .rb extension in subfolders of api
+    $logger&.debug "Require file: #{file}"
+    require file
+  end
+end
+