ditty 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b391296636a3f248171d3d71ca4c11466b8cce56f8814c271f2352e241da297
-  data.tar.gz: 8b136a384187ea59d6d8caa8f46f3dcc7a4a72939ba924ddff0eb8a332828aa1
+  metadata.gz: 35f3891fe07db1d74d92de59cbcf9ebde20c7aa9f5fdc995a5bed98445ac38de
+  data.tar.gz: 2ed19a9d156c4a043aa3d29b8ad070ed70da16637a88577ef74630734038868e
 SHA512:
-  metadata.gz: 8102d97c1b3516e4f922600055a22b5bff5293dd69fbcb92a5cd233ad0e9f2e52fc6f091e05aebcee9e1dd610e76b0049db29b1eccfd54ff09f794325156cf68
-  data.tar.gz: c1ad5e59438e58fc6dbc34d5d2a95b1c5da4a0ccb88481fc15b9dd5942ece2d7525adcf52d3d520f9fd2c91dff65829d24a27ad8fb60d66889ac6f9b983c2fba
+  metadata.gz: b11cb4cdab8e3afa910750884a5129becfe68202f779a35011e368a3d872724a41d2b3bd90b06485fdbdea740fbbe1c7165a8da50095ab7c7d767c28c2595185
+  data.tar.gz: 9e06c150bc6fd18dcc564dae5cf43bc3d9a5327541df1d64dd7b6f305381d83102ef1c9105ae4a9bcfe82cfa11881eda1fb93ec2321bd549072d92c2ee0c4acb

data/.gitignore

@@ -14,3 +14,5 @@ vendor
 *.db
 /Gemfile.dev.lock
 migrations
+/gems.*
+.env

data/.pryrc

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(PryByebug)
   Pry.commands.alias_command 'c', 'continue'
   Pry.commands.alias_command 's', 'step'

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
 Metrics/LineLength:
   Max: 120
 Layout/LeadingCommentSpace:

data/.travis.yml

@@ -1,10 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.6.0
-  - 2.5.3
-  - 2.4.5
-  - 2.3.8
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3
 gemfile: Gemfile.ci
 env:
   global:

data/CNAME

@@ -0,0 +1 @@
+ditty.io

data/Dockerfile

@@ -0,0 +1,18 @@
+FROM ruby:2.5.3-alpine3.8
+LABEL maintainer: "Sergey Shkarupa <s.shkarupa@gmail.com>"
+
+RUN apk add --no-cache \
+  build-base \
+  less \
+  git \
+  libxml2-dev \
+  libxslt-dev \
+  sqlite-dev \
+  sqlite-doc \
+  sqlite-libs \
+  && gem install bundler:1.17.3
+
+WORKDIR /usr/src/app
+
+COPY . ./
+RUN bundle install --jobs=$(nproc) --no-cache --clean

data/Gemfile.ci

@@ -4,8 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'faker'
-gem 'rubocop'
-gem 'rubocop-rspec'
 gem 'simplecov', '~> 0.13.0'
 gem 'sqlite3'
 

data/Rakefile

@@ -2,9 +2,9 @@
 
 require 'rake'
 require 'ditty'
-require 'ditty/components/app'
+require 'ditty/components/ditty'
 
-Ditty.component :app
+Ditty.component :ditty
 
 Ditty::Components.tasks
 require 'bundler/gem_tasks' if File.exist? 'ditty.gemspec'

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-architect

data/config.ru

@@ -6,14 +6,14 @@ use Rack::Session::Cookie,
     # :secure=>!TEST_MODE, # Uncomment if only allowing https:// access
     secret: File.read('.session_secret')
 
-require 'ditty/components/app'
-Ditty.component :app
+require 'ditty/components/ditty'
+Ditty.component :ditty
 
 require 'ditty/services/authentication'
 use OmniAuth::Builder do
-  Ditty::Services::Authentication.config.each do |prov, config|
+  ::Ditty::Services::Authentication.config.each do |prov, config|
     provider prov, *config[:arguments]
   end
 end
 
-run Rack::URLMap.new Ditty::Components.routes
+run Rack::URLMap.new ::Ditty::Components.routes

data/ditty.gemspec

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ditty/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'ditty'
-  spec.version       = Ditty::VERSION
+  spec.version       = ::Ditty::VERSION
   spec.authors       = ['Jurgens du Toit']
   spec.email         = ['jrgns@jadeit.co.za']
 
@@ -26,12 +26,18 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'racksh'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-sequel'
+  spec.add_development_dependency 'rubocop-thread_safety'
   spec.add_development_dependency 'timecop'
 
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'bcrypt', '~> 3.1'
   spec.add_dependency 'browser', '~> 2.5'
-  spec.add_dependency 'haml', '~> 5.0'
+  spec.add_dependency 'dotenv', '>= 2'
+  spec.add_dependency 'haml', '~> 5.1.2'
   spec.add_dependency 'logger', '~> 1.0'
   spec.add_dependency 'mail', '>= 1.7'
   spec.add_dependency 'oga', '>= 2.14'

data/docs/CNAME

@@ -0,0 +1 @@
+ditty.io

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-architect

data/docs/index.md

@@ -0,0 +1,34 @@
+# Ditty.io
+
+Ditty is a Web Application Framework built on top of the [Sinatra](http://sinatrarb.com/) framework.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'ditty'
+gem 'sqlite3'
+```
+
+You can replace `sqlite3` with a DB adapter of your choice.
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install ditty
+```
+
+## Usage
+
+1. Add the components to your rack config file. See the included [`config.ru`](https://github.com/EagerELK/ditty/blob/master/config.ru) file for an example setup
+2. Set the DB connection as the `DATABASE_URL` ENV variable: `DATABASE_URL=sqlite://development.db`
+3. Prepare the Ditty folder: `bundle exec ditty prep`
+3. Run the Ditty migrations: `bundle exec ditty migrate`
+4. Run the Ditty server: `bundle exec ditty server`

data/exe/ditty

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'ditty/cli'
 
 Ditty::CLI.start

data/lib/ditty.rb

@@ -62,7 +62,9 @@ module Ditty
       h = @components
       unless (component = h[name])
         require "ditty/components/#{name}"
-        raise ComponentError, "Component #{name} did not register itself correctly in Ditty::Components" unless (component = h[name])
+        unless (component = h[name])
+          raise ComponentError, "Component #{name} did not register itself correctly in Ditty::Components"
+        end
       end
       component
     end
@@ -76,7 +78,7 @@ module Ditty
     #
     #   Ditty::Components.register_component(:component_name, ComponentModule)
     def self.register_component(name, mod)
-      Ditty::Services::Logger.instance.info "Registering #{mod} as #{name}"
+      ::Ditty::Services::Logger.info "Registering #{mod} as #{name}"
       @components[name] = mod
     end
 

data/lib/ditty/cli.rb

@@ -1,24 +1,38 @@
 # frozen_string_literal: true
 
 # https://nandovieira.com/creating-generators-and-executables-with-thor
-require 'dotenv/load'
+require 'dotenv/load' rescue LoadError # rubocop:disable Style/RescueModifier - Ignore dotenv/load errors
 require 'thor'
 require 'rack'
 require 'rake'
+require 'ditty/db' if ENV['DATABASE_URL']
+require 'ditty/generators/crud_generator'
+require 'ditty/generators/project_generator'
+require 'ditty/generators/migration_generator'
+require 'ditty/components/ditty'
 
 module Ditty
   class CLI < Thor
     include Thor::Actions
 
+    register ::Ditty::Generators::CrudGenerator, 'crud', 'crud NAME', 'Generate a CRUD endpoint'
+
+    register ::Ditty::Generators::ProjectGenerator, 'init', 'init', 'Initialize a Ditty Project'
+
+    register ::Ditty::Generators::MigrationGenerator, 'migration', 'migration NAME', 'Create a new Sequel migration'
+
+    default_task :server
+
     desc 'server', 'Start the Ditty server'
     require './application' if File.exist?('application.rb')
-    Ditty::Components.tasks
+    ::Ditty::Components.tasks
     def server
       # Ensure the token files are present
       Rake::Task['ditty:generate_tokens'].invoke
 
       # Prep Ditty
-      Rake::Task['ditty:prep'].invoke
+      Rake::Task['ditty:prep:folders'].invoke
+      Rake::Task['ditty:prep:migrations'].invoke
 
       # Check the migrations
       Rake::Task['ditty:migrate:check'].invoke
@@ -35,7 +49,7 @@ module Ditty
     desc 'migrate', 'Run the Ditty migrations'
     def migrate
       # Prep Ditty
-      Rake::Task['ditty:prep'].invoke
+      Rake::Task['ditty:prep:migrations'].invoke
 
       # Run the migrations
       Rake::Task['ditty:migrate:up'].invoke
@@ -44,5 +58,15 @@ module Ditty
       Rake::Task['ditty:dump_schema'].invoke
       puts 'Ditty DB Schema Dumped'
     end
+
+    desc 'seed', 'Seed the predefined seeind data'
+    def seed
+      Rake::Task['ditty:seed'].invoke
+    end
+
+    desc 'console', 'Open a fully loaded console'
+    def console
+      Rake::Task['ditty:console'].invoke
+    end
   end
 end

data/lib/ditty/components/{app.rb → ditty.rb}

@@ -4,10 +4,10 @@ require 'ditty'
 require 'ditty/services/settings'
 
 module Ditty
-  class App
+  class Ditty
     def self.load
       controllers = File.expand_path('../controllers', __dir__)
-      Dir.glob("#{controllers}/*.rb").each { |f| require f }
+      Dir.glob("#{controllers}/*.rb").sort.each { |f| require f }
 
       require 'ditty/models/user'
       require 'ditty/models/role'
@@ -29,15 +29,19 @@ module Ditty
       File.expand_path('../../../views', __dir__)
     end
 
+    def self.public_folder
+      File.expand_path('../../../public', __dir__)
+    end
+
     def self.routes
       load
       {
-        '/' => ::Ditty::Main,
-        '/auth' => ::Ditty::Auth,
-        '/users' => ::Ditty::Users,
-        '/roles' => ::Ditty::Roles,
-        '/audit-logs' => ::Ditty::AuditLogs,
-        '/login-traits' => ::Ditty::UserLoginTraits
+        '/' => ::Ditty::MainController,
+        '/auth' => ::Ditty::AuthController,
+        '/users' => ::Ditty::UsersController,
+        '/roles' => ::Ditty::RolesController,
+        '/audit-logs' => ::Ditty::AuditLogsController,
+        '/login-traits' => ::Ditty::UserLoginTraitsController
       }
     end
 
@@ -53,7 +57,8 @@ module Ditty
           items: [
             { order: 10, link: '/users/', text: 'Users', target: ::Ditty::User, icon: 'user' },
             { order: 20, link: '/roles/', text: 'Roles', target: ::Ditty::Role, icon: 'check-square' },
-            { order: 30, link: '/audit-logs/', text: 'Audit Logs', target: ::Ditty::AuditLog, icon: 'history' }
+            { order: 30, link: '/audit-logs/', text: 'Audit Logs', target: ::Ditty::AuditLog, icon: 'history' },
+            { order: 40, link: '/login-traits/', text: 'User Login Traits', target: ::Ditty::UserLoginTrait, icon: 'list' }
           ]
         }
       ]
@@ -63,18 +68,18 @@ module Ditty
       proc do
         load
 
-        ::Ditty::Role.find_or_create(name: 'super_admin')
-        ::Ditty::Role.find_or_create(name: 'admin')
-        ::Ditty::Role.find_or_create(name: 'user')
+        sa = ::Ditty::Role.find_or_create(name: 'super_admin')
+        admin = ::Ditty::Role.find_or_create(name: 'admin') { |e| e.parent = sa }
+        ::Ditty::Role.find_or_create(name: 'user') { |e| e.parent = admin }
       end
     end
 
     def self.tasks
       Kernel.load 'ditty/tasks/ditty.rake'
-      auth_settings = Ditty::Services::Settings[:authentication] || {}
+      auth_settings = ::Ditty::Services::Settings[:authentication] || {}
       Kernel.load 'ditty/tasks/omniauth-ldap.rake' if auth_settings.key?(:ldap)
     end
   end
 end
 
-Ditty::Components.register_component(:app, Ditty::App)
+Ditty::Components.register_component(:ditty, Ditty::Ditty)

data/lib/ditty/controllers/{application.rb → application_controller.rb}

@@ -17,13 +17,14 @@ require 'rack/contrib'
 require 'rack/csrf'
 
 module Ditty
-  class Application < Sinatra::Base
+  class ApplicationController < Sinatra::Base
     include ActiveSupport::Inflector
 
     set :root, ENV['APP_ROOT'] || ::File.expand_path(::File.dirname(__FILE__) + '/../../../')
     set :map_path, nil
     set :view_location, nil
     set :view_folder, nil
+    set :base_path, nil
     set :model_class, nil
     set :raise_sinatra_param_exceptions, true
     set track_actions: false
@@ -42,7 +43,7 @@ module Ditty
 
     helpers do
       def logger
-        Ditty::Services::Logger.instance
+        ::Ditty::Services::Logger
       end
 
       def base_path
@@ -51,9 +52,9 @@ module Ditty
 
       def view_location
         return settings.view_location if settings.view_location
-        return underscore(pluralize(demodulize(settings.model_class))) if settings.model_class
 
-        underscore(demodulize(self.class))
+        loc = demodulize(settings.model_class || self.class)
+        pluralize(underscore(loc.gsub(/Controller\Z/, '')))
       end
 
       def browser
@@ -61,24 +62,26 @@ module Ditty
       end
 
       def config(name, default = '')
-        Ditty::Services::Settings[name] || default
+        ::Ditty::Services::Settings[name] || default
       end
     end
 
     def view_folders
       folders = ['./views']
       folders << settings.view_folder if settings.view_folder
-      folders << Ditty::App.view_folder
+      folders << ::Ditty::Ditty.view_folder
     end
 
     def find_template(views, name, engine, &block)
       # Backwards compatability
-      return super(views, name, engine, &block) if settings.view_folder.nil? && self.class.name.split('::').first != 'Ditty'
+      if settings.view_folder.nil? && self.class.name.split('::').first != 'Ditty'
+        return super(views, name, engine, &block)
+      end
 
       view_folders.each do |folder|
         super(folder, name, engine, &block) # Root
       end
-      raise Ditty::TemplateNotFoundError, "Could not find template `#{name}`"
+      raise ::Ditty::TemplateNotFoundError, "Could not find template `#{name}`"
     end
 
     configure :production do
@@ -92,7 +95,7 @@ module Ditty
 
     configure :production, :development do
       disable :logging
-      use Rack::CommonLogger, Ditty::Services::Logger.instance
+      use Rack::CommonLogger, ::Ditty::Services::Logger
     end
 
     not_found do
@@ -102,7 +105,11 @@ module Ditty
           haml :'404', locals: { title: '4 oh 4' }, layout: layout
         end
         format.json do
-          json code: 404, errors: ['Not Found']
+          if response.body.empty?
+            json code: 404, errors: ['Not Found']
+          else
+            [404, response.body]
+          end
         end
       end
     end
@@ -134,30 +141,46 @@ module Ditty
       end
     end
 
-    error Sequel::ValidationFailed do
+    error ::Sinatra::Param::InvalidParameterError do
       respond_to do |format|
-        entity = env['sinatra.error'].model
-        errors = env['sinatra.error'].errors
         status 400
         format.html do
-          action = entity.id ? :edit : :new
-          haml :"#{view_location}/#{action}", locals: { entity: entity, title: heading(action) }, layout: layout
+          flash.now[:danger] = env['sinatra.error'].message
+          haml :'400', locals: { title: '4 oh oh' }, layout: layout
         end
         format.json do
-          json code: 400, errors: errors, full_errors: errors.full_messages
+          json code: 400, errors: { env['sinatra.error'].param => env['sinatra.error'].message }, full_errors: [env['sinatra.error'].message]
         end
       end
     end
 
-    error Sinatra::Param::InvalidParameterError do
+    error ::Sequel::NoMatchingRow do
       respond_to do |format|
+        status 404
+        format.html do
+          haml :'404', locals: { title: '4 oh 4' }, layout: layout
+        end
+        format.json do
+          if response.body.empty?
+            json code: 404, errors: ['Not Found']
+          else
+            [404, response.body]
+          end
+        end
+      end
+    end
+
+    error ::Sequel::ValidationFailed do
+      respond_to do |format|
+        entity = env['sinatra.error'].model
+        errors = env['sinatra.error'].errors
         status 400
         format.html do
-          flash.now[:danger] = env['sinatra.error'].message
-          haml :'400', locals: { title: '4 oh oh' }, layout: layout
+          action = entity.id ? :edit : :new
+          haml :"#{view_location}/#{action}", locals: { entity: entity, title: heading(action) }, layout: layout
         end
         format.json do
-          json code: 400, errors: { env['sinatra.error'].param => env['sinatra.error'].message }, full_errors: [env['sinatra.error'].message]
+          json code: 400, errors: errors, full_errors: errors.full_messages
         end
       end
     end
@@ -177,7 +200,7 @@ module Ditty
       end
     end
 
-    error Ditty::TemplateNotFoundError do
+    error ::Ditty::TemplateNotFoundError do
       # TODO: Display a better error message
       error = env['sinatra.error']
       broadcast(:application_error, error)
@@ -207,10 +230,10 @@ module Ditty
 
     before(/.*/) do
       logger.info "Running with #{self.class} - #{request.path_info}"
-      if request.path =~ /.*\.json\Z/
+      if /.*\.json\Z/.match?(request.path)
         content_type :json
         request.path_info = request.path_info.gsub(/.json$/, '')
-      elsif request.path =~ /.*\.csv\Z/
+      elsif /.*\.csv\Z/.match?(request.path)
         content_type :csv
         request.path_info = request.path_info.gsub(/.csv$/, '')
       elsif request.env['ACCEPT']
@@ -222,15 +245,21 @@ module Ditty
 
     after do
       return if params[:layout].nil?
+      return unless response.body.respond_to?(:map)
 
-      response.body = response.body.map do |resp|
-        document = Oga.parse_html(resp)
-        document.css('a').each do |elm|
-          unless (href = elm.get('href')).nil?
-            elm.set 'href', with_layout(href)
+      begin
+        orig = response.body
+        response.body = response.body.map do |resp|
+          document = Oga.parse_html(resp)
+          document.css('a').each do |elm|
+            unless (href = elm.get('href')).nil?
+              elm.set 'href', with_layout(href)
+            end
           end
+          document.to_xml
         end
-        document.to_xml
+      rescue StandardError => _e
+        orig
       end
     end
   end