ditty 0.8.0 → 0.9.0

data/lib/ditty/generators/migration_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'thor/group'
+require 'active_support/inflector'
+
+module Ditty
+  module Generators
+    class MigrationGenerator < Thor::Group
+      include Thor::Actions
+
+      attr_reader :namespace, :folder
+
+      desc 'Creates a new Sequel migration for the current project'
+      argument :name, type: :string, desc: 'Name of the migration'
+
+      def self.source_root
+        File.expand_path('../templates', __dir__)
+      end
+
+      def create_model
+        filename = File.join('migrations', "#{Time.now.strftime('%Y%m%d')}_#{name.underscore}.rb")
+        template '../templates/migration.rb.erb', filename
+      end
+    end
+  end
+end

data/lib/ditty/generators/project_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'thor/group'
+require 'active_support/inflector'
+
+module Ditty
+  module Generators
+    class ProjectGenerator < Thor::Group
+      include Thor::Actions
+
+      attr_reader :name, :namespace, :folder
+
+      desc 'Initialize a new Ditty project in the current folder'
+
+      def setup
+        @name      = File.basename(Dir.getwd)
+        @folder    = @name.underscore
+        @namespace = folder.classify
+        @name      = @name.titleize
+      end
+
+      def self.source_root
+        File.expand_path('../templates', __dir__)
+      end
+
+      def create_startup_files
+        directory 'logs'
+        directory 'pids'
+        directory 'public'
+        copy_file '.gitignore', './.gitignore'
+        copy_file 'env.example', './.env'
+        copy_file '.rubocop.yml', './.rubocop.yml'
+        copy_file '.rspec', './.rspec'
+
+        template 'lib/project.rb.erb', "lib/#{folder}.rb"
+
+        copy_file 'application.rb', './application.rb'
+        copy_file 'config.ru', './config.ru'
+        copy_file 'Rakefile', './Rakefile'
+        copy_file 'sidekiq.rb', './config/sidekiq.rb'
+        copy_file 'sidekiq.yml', './config/sidekiq.yml'
+
+        copy_file 'spec_helper.rb', './specs/spec_helper.rb'
+        copy_file '../../../spec/support/api_shared_examples.rb', './specs/support/api_shared_examples.rb'
+        copy_file '../../../spec/support/crud_shared_examples.rb', './specs/support/crud_shared_examples.rb'
+
+        template 'settings.yml.erb', './config/settings.yml'
+      end
+    end
+  end
+end

data/lib/ditty/helpers/component.rb

@@ -33,11 +33,12 @@ module Ditty
         param :q, String
         param :page, Integer, min: 1, default: 1
         param :sort, String
-        param :order, String, in: %w[asc desc], transform: :downcase, default: 'asc'
+        param :order, String, in: %w[asc desc], transform: :downcase
         # TODO: Can we dynamically validate the search / filter fields?
 
         ds = dataset
         ds = ds.dataset if ds.respond_to?(:dataset)
+        params[:order] ||= 'asc' if params[:sort]
         return ds if params[:count] == 'all'
 
         params[:count] = check_count

data/lib/ditty/helpers/pundit.rb

@@ -12,23 +12,39 @@ module Ditty
         super
       end
 
-      def permitted_attributes(record, action)
-        param_key = PolicyFinder.new(record).param_key
+      def permitted_attributes(record, action = nil)
         policy = policy(record)
+        action ||= record.new? ? :create : :update
         method_name = if policy.respond_to?("permitted_attributes_for_#{action}")
                         "permitted_attributes_for_#{action}"
                       else
                         'permitted_attributes'
                       end
+        policy.public_send(method_name)
+      end
 
-        policy_fields = policy.public_send(method_name)
+      def permitted_parameters(record, action = nil)
+        param_key = PolicyFinder.new(record).param_key
+        policy_fields = permitted_attributes(record, action)
         request.params.fetch(param_key, {}).select do |key, _value|
           policy_fields.include? key.to_sym
         end
       end
 
+      def permitted_response_attributes(record, method = :values)
+        policy = policy(record)
+        response = record.send(method)
+
+        return response unless policy.respond_to? :response_attributes
+
+        policy_fields = policy.response_attributes
+        response.select do |key, _value|
+          policy_fields.include? key.to_sym
+        end
+      end
+
       def pundit_user
-        current_user
+        current_user unless current_user&.anonymous?
       end
     end
   end

data/lib/ditty/helpers/response.rb

@@ -2,15 +2,17 @@
 
 require 'csv'
 
+require 'csv'
+
 module Ditty
   module Helpers
     module Response
-      def list_response(result)
+      def list_response(result, view: 'index')
         respond_to do |format|
           format.html do
             actions = {}
             actions["#{base_path}/new"] = "New #{heading}" if policy(settings.model_class).create?
-            haml :"#{view_location}/index",
+            haml :"#{view_location}/#{view}",
                  locals: { list: result, title: heading(:list), actions: actions },
                  layout: layout
           end
@@ -18,7 +20,7 @@ module Ditty
             # TODO: Add links defined by actions (New #{heading})
             total = result.respond_to?(:pagination_record_count) ? result.pagination_record_count : result.count
             json(
-              'items' => result.all.map(&:for_json),
+              'items' => result.all.map { |e| permitted_response_attributes(e, :for_json) },
               'page' => (params['page'] || 1).to_i,
               'count' => result.count,
               'total' => total
@@ -39,18 +41,18 @@ module Ditty
         respond_to do |format|
           format.html do
             flash[:success] = "#{heading} Created"
-            redirect with_layout("#{base_path}/#{entity.id}")
+            redirect with_layout(flash[:redirect_to] || "#{base_path}/#{entity.display_id}")
           end
           format.json do
             content_type :json
-            redirect "#{base_path}/#{entity.id}", 201
+            redirect "#{base_path}/#{entity.display_id}", 201
           end
         end
       end
 
       def actions(entity = nil)
         actions = {}
-        actions["#{base_path}/#{entity.id}/edit"] = "Edit #{heading}" if entity && policy(entity).update?
+        actions["#{base_path}/#{entity.display_id}/edit"] = "Edit #{heading}" if entity && policy(entity).update?
         actions["#{base_path}/new"] = "New #{heading}" if policy(settings.model_class).create?
         actions
       end
@@ -66,7 +68,13 @@ module Ditty
           end
           format.json do
             # TODO: Add links defined by actions (Edit #{heading})
-            json entity.for_json
+            json permitted_response_attributes(entity, :for_json)
+          end
+          format.csv do
+            CSV.generate do |csv|
+              csv << entity.for_csv.keys
+              csv << entity.for_csv.values
+            end
           end
           format.csv do
             CSV.generate do |csv|
@@ -82,11 +90,11 @@ module Ditty
           format.html do
             # TODO: Ability to customize the return path and message?
             flash[:success] = "#{heading} Updated"
-            redirect with_layout("#{base_path}/#{entity.id}")
+            redirect with_layout(flash[:redirect_to] || back || "#{base_path}/#{entity.display_id}")
           end
           format.json do
-            headers 'Location' => "#{base_path}/#{entity.id}"
-            json body entity.for_json
+            content_type :json
+            redirect "#{base_path}/#{entity.display_id}", 200, json(entity.for_json)
           end
         end
       end
@@ -95,12 +103,11 @@ module Ditty
         respond_to do |format|
           format.html do
             flash[:success] = "#{heading} Deleted"
-            redirect with_layout(base_path.to_s)
+            redirect with_layout(flash[:redirect_to] || back || base_path)
           end
           format.json do
             content_type :json
-            headers 'Location' => base_path.to_s
-            status 204
+            redirect base_path.to_s, 204
           end
         end
       end

data/lib/ditty/helpers/views.rb

@@ -24,9 +24,11 @@ module Ditty
       def form_control(name, model, opts = {})
         label = opts.delete(:label) || name.to_s.titlecase
         klass = opts.delete(:class) || 'form-control' unless opts[:type] == 'file'
+        klass = "#{klass} is-invalid" if model.errors[name]
         group = opts.delete(:group) || model.class.to_s.demodulize.underscore
         field = opts.delete(:field) || name
         default = opts.delete(:default) || nil
+        help_text = opts.delete(:help_text) || nil
 
         attributes = { type: 'text', id: name, name: "#{group}[#{name}]", class: klass }.merge(opts)
         haml :'partials/form_control', locals: {
@@ -36,7 +38,8 @@ module Ditty
           name: name,
           group: group,
           field: field,
-          default: default
+          default: default,
+          help_text: help_text
         }
       end
 
@@ -47,7 +50,8 @@ module Ditty
         haml :'partials/filter_control', locals: {
           name: filter[:name],
           label: opts[:label] || filter[:name].to_s.titlecase,
-          options: send(meth)
+          options: send(meth),
+          total_filters: opts[:filters]
         }
       end
 
@@ -98,7 +102,7 @@ module Ditty
       def pagination(list, base_path, qp = {})
         return unless list.respond_to?(:pagination_record_count) || list.respond_to?(:total_entries)
 
-        list = Ditty::Services::PaginationWrapper.new(list)
+        list = ::Ditty::Services::PaginationWrapper.new(list)
         locals = {
           first_link: "#{base_path}?" + query_string(qp.merge(page: 1)),
           next_link: list.last_page? ? '#' : "#{base_path}?" + query_string(qp.merge(page: list.next_page)),

data/lib/ditty/listener.rb

@@ -17,7 +17,9 @@ module Ditty
     end
 
     def method_missing(method, *args)
-      return unless args[0].is_a?(Hash) && args[0][:target].is_a?(Sinatra::Base) && args[0][:target].settings.track_actions
+      unless args[0].is_a?(Hash) && args[0][:target].is_a?(Sinatra::Base) && args[0][:target].settings.track_actions
+        return
+      end
 
       log_action(
         user_traits(args[0][:target]).merge(
@@ -69,7 +71,7 @@ module Ditty
 
     def log_action(values)
       values[:user] ||= values[:target].current_user if values[:target]
-      @mutex.synchronize { Ditty::AuditLog.create values }
+      @mutex.synchronize { ::Ditty::AuditLog.create values }
     end
 
     def user_traits(target)
@@ -84,4 +86,4 @@ module Ditty
   end
 end
 
-Wisper.subscribe(Ditty::Listener.new) unless ENV['RACK_ENV'] == 'test'
+Wisper.subscribe(::Ditty::Listener.new) unless ENV['RACK_ENV'] == 'test'

data/lib/ditty/memcached.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'ditty/services/logger'
+
+Ditty::Services::Logger.info 'Setting up caching'
+require 'memcached'
+CACHE = Memcached.new(ENV['MEMCACHED_URL'])
+Sequel::Model.plugin :caching, CACHE, ignore_exceptions: true

data/lib/ditty/middleware/accept_extension.rb

@@ -8,7 +8,7 @@ module Ditty
     class AcceptExtension
       attr_reader :env, :regex, :content_type
 
-      def initialize(app, regex = /\A(.*)\.json(\/?)\Z/, content_type = 'application/json')
+      def initialize(app, regex = %r{\A(.*)\.json(/?)\Z}, content_type = 'application/json')
         # @mutex = Mutex.new
         @app = app
         @regex = regex
@@ -19,7 +19,7 @@ module Ditty
         @env = env
 
         request = Rack::Request.new(env)
-        if request.path =~ regex
+        if request.path&.match?(regex)
           request.path_info = request.path_info.gsub(regex, '\1\2')
           env = request.env
           env['ACCEPT'] = content_type

data/lib/ditty/middleware/error_catchall.rb

@@ -16,8 +16,8 @@ module Ditty
         begin
           @app.call env
         rescue StandardError => e
-          ::Ditty::Services::Logger.instance.error "Ditty Catchall: #{e.class}"
-          ::Ditty::Services::Logger.instance.error e
+          ::Ditty::Services::Logger.error "Ditty Catchall: #{e.class}"
+          ::Ditty::Services::Logger.error e
           [500, {}, ['Unknown Error']]
         end
       end

data/lib/ditty/models/base.rb

@@ -8,6 +8,10 @@ module Ditty
       values
     end
 
+    def display_id
+      self[:slug] || self[:guid] || self[:id]
+    end
+
     alias for_csv for_json
   end
 end

data/lib/ditty/models/role.rb

@@ -5,6 +5,7 @@ require 'ditty/models/base'
 module Ditty
   class Role < ::Sequel::Model
     include ::Ditty::Base
+    plugin :tree
 
     many_to_many :users
 

data/lib/ditty/models/user.rb

@@ -17,11 +17,20 @@ module Ditty
 
     def role?(check)
       @roles ||= Hash.new do |h, k|
-        h[k] = !roles_dataset.first(name: k).nil?
+        role_or_descendant = roles.find do |role|
+          role.name == k || role.descendants.map(&:name).include?(k)
+        end
+        h[k] = !role_or_descendant.nil?
       end
       @roles[check]
     end
 
+    def all_roles
+      roles.inject([]) do |memo, role|
+        memo + [role] + role.descendants
+      end.uniq
+    end
+
     def method_missing(method_sym, *arguments, &block)
       if respond_to_missing?(method_sym)
         role?(method_sym[0..-2])
@@ -68,6 +77,10 @@ module Ditty
       email
     end
 
+    def display_name
+      name || username
+    end
+
     class << self
       def anonymous_user
         role = ::Ditty::Role.find_or_create(name: 'anonymous')

data/lib/ditty/policies/role_policy.rb

@@ -25,7 +25,7 @@ module Ditty
     end
 
     def permitted_attributes
-      [:name]
+      %i[parent_id name]
     end
 
     class Scope < ApplicationPolicy::Scope

data/lib/ditty/policies/user_login_trait_policy.rb

@@ -13,7 +13,7 @@ module Ditty
     end
 
     def read?
-      user && (record.user_id || user.super_admin?)
+      user && (record.user_id == user.id || user.super_admin?)
     end
 
     def update?

data/lib/ditty/services/authentication.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'ditty/controllers/application'
+require 'ditty/controllers/application_controller'
 require 'ditty/services/settings'
 require 'ditty/services/logger'
 require 'backports/2.4.0/hash/compact'
 
 require 'omniauth'
-OmniAuth.config.logger = Ditty::Services::Logger.instance
-OmniAuth.config.path_prefix = "#{Ditty::Application.map_path}/auth"
+OmniAuth.config.logger = ::Ditty::Services::Logger
+OmniAuth.config.path_prefix = "#{::Ditty::ApplicationController.map_path}/auth"
 OmniAuth.config.on_failure = proc { |env|
   next [400, {}, []] if env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
 
@@ -28,8 +28,9 @@ module Ditty
 
         def setup
           providers.each do |provider|
+            req = config.dig(provider, :require) || "omniauth/#{provider}"
             begin
-              require "omniauth/#{provider}"
+              require req
             rescue LoadError
               require "omniauth-#{provider}"
             end
@@ -37,7 +38,7 @@ module Ditty
         end
 
         def config
-          default.merge Ditty::Services::Settings.values(:authentication) || {}
+          default.merge ::Ditty::Services::Settings.values(:authentication) || {}
         end
 
         def provides?(provider)
@@ -46,15 +47,15 @@ module Ditty
 
         def default
           require 'ditty/models/identity'
-          require 'ditty/controllers/auth'
+          require 'ditty/controllers/auth_controller'
           {
             identity: {
               arguments: [
                 {
                   fields: [:username],
-                  model: Ditty::Identity,
-                  on_login: Ditty::Auth,
-                  on_registration: Ditty::Auth,
+                  model: ::Ditty::Identity,
+                  on_login: ::Ditty::AuthController,
+                  on_registration: ::Ditty::AuthController,
                   locate_conditions: ->(req) { { username: req['username'] } }
                 }
               ]
@@ -66,4 +67,4 @@ module Ditty
   end
 end
 
-Ditty::Services::Authentication.setup
+::Ditty::Services::Authentication.setup